sphinxcontrib-htmlhelp

sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files

sphinxcontrib-htmlhelp Permissive license DORMANT ★ 2 v2.1.0 released 2024-07-29

Install

sphinxcontrib-htmlhelp on PyPI

pip

pip install sphinxcontrib-htmlhelp

uv

uv add sphinxcontrib-htmlhelp

poetry

poetry add sphinxcontrib-htmlhelp

Package facts

License	not declared (permissive)
Python support	supports the current Python release (>=3.9)
Install friction	low — pure-Python wheel
Runtime dependencies	none
Maintenance	dormant — 745 days since the last release
Last repo commit	2024-10-25
First released	2019-02-14
Popularity	one of the top 1,000 most-downloaded packages on PyPI (30-day window, as of 2026-08-13)
Known vulnerabilities	none known (OSV.dev, checked 2026-08-13)

Evidence: sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl

Development Status :: 5 - Production/StableEnvironment :: ConsoleEnvironment :: Web EnvironmentFramework :: SphinxFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersIntended Audience :: EducationLicense :: OSI Approved :: BSD LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.9Topic :: DocumentationTopic :: Documentation :: SphinxTopic :: Text ProcessingTopic :: Utilities

About sphinxcontrib-htmlhelp

from the package's own PyPI description — quoted content, verbatim

====================== sphinxcontrib-htmlhelp ======================

sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files.

For more details, please visit http://www.sphinx-doc.org/.

Installing

Install from PyPI::

pip install -U sphinxcontrib-htmlhelp

Contributing

See CONTRIBUTING.rst__

.. __: https://github.com/sphinx-doc/sphinx/blob/master/CONTRIBUTING.rst

Read as markdown · JSON record · Source repository · Homepage

AI interpretation — verify before relying

AI-generated interpretation of the package facts above; every digit, version, license, or vulnerability id it cites is grounded in the facts already shown on this page

A Sphinx extension that generates HTML Help (.chm) files from reStructuredText documentation, enabling offline browsing of Sphinx-built docs in Windows Help format.

Low friction: pure Python wheel with no runtime dependencies. Maintenance is dormant (745 days since last release, last commit 2024-10-25), but the package is marked Production/Stable and remains functional for its narrow, mature use case.

Permissive license (BSD) with no restrictions on commercial or private use, modification, or redistribution, provided attribution is retained.

Usage

pip install sphinxcontrib-htmlhelp

# In conf.py, add to extensions:
extensions = ['sphinxcontrib.htmlhelp']

# Build HTML Help output:
sphinx-build -b htmlhelp source build/htmlhelp

Requires Python ≥3.9 and an existing Sphinx project with reStructuredText source files.

Verdict: A stable, zero-dependency Sphinx extension for niche use (Windows HTML Help output). No known vulnerabilities and permissive licensing make it safe to adopt, but dormant maintenance (745 days) means bug fixes or Python version support updates are unlikely—suitable only if you actively need .chm file generation.

Needs verification

Whether the package still works reliably with Python 3.13 despite no recent releases.
Whether Windows HTML Help (.chm) format remains relevant or if this extension is primarily legacy support.

sphinx html help extensiongenerate chm files sphinxwindows help file buildersphinx documentation offlinehtml help output sphinxchm file generatorsphinx htmlhelp builder