Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extension sphinxcontrib-htmlhelp has typo #12308

Open
ukulle opened this issue Apr 19, 2024 · 0 comments
Open

Extension sphinxcontrib-htmlhelp has typo #12308

ukulle opened this issue Apr 19, 2024 · 0 comments

Comments

@ukulle
Copy link

ukulle commented Apr 19, 2024

Describe the bug

class HTMLHelpBuilder in __init__.py names an incorrect file extension in the string of the variable epilog for the correct generated HTMLHelp project file .

Incorrect is the part .htp because .hhp is meant.

How to Reproduce

Code snippet:

class HTMLHelpBuilder(StandaloneHTMLBuilder):
    """
    Builder that also outputs Windows HTML help project, contents and
    index files.  Adapted from the original Doc/tools/prechm.py.
    """
    name = 'htmlhelp'
    epilog = __('You can now run HTML Help Workshop with the .htp file in '
                '%(outdir)s.')

epilog should become:

    epilog = __('You can now run HTML Help Workshop with the .hhp file in '
                '%(outdir)s.')

Environment Information

Platform:              win32; (Windows-10-10.0.19045-SP0)
Python version:        3.11.4 (tags/v3.11.4:d2340ef, Jun  7 2023, 05:45:37) [MSC v.1934 64 bit (AMD64)])
Python implementation: CPython
Sphinx version:        7.2.6
Docutils version:      0.20.1
Jinja2 version:        3.1.2
Pygments version:      2.16.1

Sphinx extensions

No response

Additional context

No response

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

No branches or pull requests

2 participants