Skip to content

fix: correct .htp typo to .hhp in HTMLHelpBuilder epilog#43

Open
VedantMadane wants to merge 2 commits into
sphinx-doc:masterfrom
VedantMadane:fix/typo-hhp-extension
Open

fix: correct .htp typo to .hhp in HTMLHelpBuilder epilog#43
VedantMadane wants to merge 2 commits into
sphinx-doc:masterfrom
VedantMadane:fix/typo-hhp-extension

Conversation

@VedantMadane

@VedantMadane VedantMadane commented Jan 16, 2026

Copy link
Copy Markdown

Summary

This PR fixes a typo in the \HTMLHelpBuilder.epilog\ message.

Problem

The epilog message incorrectly states:

You can now run HTML Help Workshop with the .htp file in %(outdir)s.

However, HTML Help Workshop uses .hhp files as project files, not .htp files.

Fix

Changed .htp to .hhp in the epilog message.

Fixes sphinx-doc/sphinx#12308

The epilog message incorrectly referred to '.htp' files when it should
have said '.hhp' files. The HTML Help Workshop uses .hhp files as project
files.

Fixes sphinx-doc/sphinx#12308
@jdillard

jdillard commented Jun 2, 2026

Copy link
Copy Markdown
Member

why the index.rst change?

@VedantMadane

Copy link
Copy Markdown
Author

The index.rst change is from a follow-up commit (931a1c7): "fix: replace deprecated keyword index entry with pair to fix CI on Sphinx 9+".
The tests/roots/test-chm/index.rst fixture is used by the htmlhelp tests (including the ones validating .hhk output). The old bare keyword: with syntax is deprecated in Sphinx 9+ and was causing CI failures. I added the minimal normalization in a separate commit so the PR keeps the test suite green on current Sphinx.
Ready to split it into its own tiny PR if preferred, it was just the smallest change needed to make the htmlhelp tests pass while I was verifying the epilog fix.

@jdillard

jdillard commented Jun 8, 2026

Copy link
Copy Markdown
Member

Ah I see, a separate PR has already been made for that https://github.com/sphinx-doc/sphinxcontrib-htmlhelp/pull/54/changes.

It looks like this PR a duplicate of #42 and can be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Extension sphinxcontrib-htmlhelp has typo

2 participants