Install & Compatibility
Where this runs
tested against v2.1.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 18.7MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 1.6s · import 0.000s · 19MB
17MB installed
● package 17MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
sphinxcontrib.htmlhelp
✓ extensions = ['sphinxcontrib.htmlhelp']
Sphinx extensions are enabled by adding their module name to the `extensions` list in `conf.py`, not via direct Python `import` statements in user code.
After installing the package, enable the extension by adding `'sphinxcontrib.htmlhelp'` to the `extensions` list in your Sphinx project's `conf.py` file. Then, build your documentation using the `htmlhelp` builder.
# 1. Install the extension
# pip install sphinxcontrib-htmlhelp
# 2. In your Sphinx project's conf.py file, add 'sphinxcontrib.htmlhelp' to the extensions list:
# conf.py
# ...
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinxcontrib.htmlhelp'
]
# ...
# Optionally, configure HTML Help specific options (e.g., the output basename):
htmlhelp_basename = 'MyProjectDoc'
Debug
Known issues
gotchaGenerating the final HTML Help (.chm) file from the Sphinx output requires the Microsoft HTML Help Workshop. This is a Windows-only tool, meaning the CHM compilation step cannot be performed on Linux, macOS, or other non-Windows operating systems.fixEnsure you are building and compiling on a Windows environment or target a different output format.
affects: All versions
gotchaThe HTML Help (CHM) format is an older, Windows-specific documentation format. It may not be suitable for modern web-based documentation workflows, cross-platform users, or integration with contemporary documentation platforms. Consider if this format truly meets your audience's needs.fixEvaluate whether alternative Sphinx builders (e.g., HTML, PDF via LaTeX, Epub) might better serve your documentation's distribution and accessibility requirements.
affects: All versions
breakingThe `sphinxcontrib-htmlhelp` library explicitly requires Python 3.9 or newer. Older Python versions are not supported.fixUpgrade your Python environment to 3.9 or a newer compatible version.
affects: <2.1.0 (earlier versions might support older Python, but current requires >=3.9)
deprecatedWhile the `sphinxcontrib-htmlhelp` extension itself is actively maintained, the underlying HTML Help (.chm) format has largely been superseded by web-based documentation. Depending on your target audience, using this format might limit accessibility and modern features.fixConsider migrating to standard HTML, Read the Docs, or other modern documentation platforms for better compatibility and user experience.
affects: All versions
Upgrade
Version history
2.1.0latest on PyPI · released Jul 29, 2024
Audit
Dependencies
SphinxrequiredThis is a Sphinx extension and requires Sphinx to function. It is compatible with Sphinx versions that support its internal APIs, notably Sphinx >= 6.1 based on internal checks.