Install & Compatibility
Where this runs
tested against v2.0.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.6MB
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.devhelp
✓ extensions = ['sphinxcontrib.devhelp']
Sphinx extensions are configured by adding their full dotted name to the `extensions` list within your project's `conf.py` file, not via a standard Python `import` statement in the file itself.
After installing the package, enable the extension by adding `sphinxcontrib.devhelp` to the `extensions` list in your Sphinx project's `conf.py`. Then, build the documentation using the `devhelp` builder. You might need to replace `doc/source` and `doc/build/devhelp` with your actual source and build directories.
# conf.py
# ... (other Sphinx configurations)
# Add 'sphinxcontrib.devhelp' to your extensions list
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinxcontrib.devhelp',
]
# Optional: Configure the basename for the Devhelp output
devhelp_basename = 'MyProjectDevhelp'
# Build from terminal
# In your Sphinx project's root directory:
# sphinx-build -b devhelp doc/source doc/build/devhelp
Debug
Known issues
breakingVersion 2.0.0 (and Sphinx 2.0.0 which it follows) dropped support for Python 2.7, Python 3.4, and Docutils 0.11. This extension now requires Python >=3.9.fixUpgrade your Python environment to 3.9 or newer and ensure Docutils is up-to-date. If these are not possible, use an older version of `sphinxcontrib-devhelp` compatible with your environment.
affects: < 2.0.0
breakingPrior to Sphinx 2.0.0, `sphinxcontrib-devhelp` was often bundled directly with Sphinx. With Sphinx 2.0.0 and later, it became a separate, explicitly installable package.fixProjects using Sphinx 2.0.0 or newer must explicitly `pip install sphinxcontrib-devhelp` as it is no longer included by default.
affects: >= 2.0.0 (Sphinx)
gotchaGenerating Devhelp documents requires invoking the dedicated `devhelp` builder. Standard `html` builds will not produce Devhelp output.fixUse the command `sphinx-build -b devhelp path/to/source path/to/build/devhelp` or run `make devhelp` if you use a standard Sphinx Makefile.
affects: All
gotchaAfter building, the generated Devhelp documents are not automatically registered with the Devhelp application. They need to be manually linked or placed in a specific directory for Devhelp to find them.fixRefer to the output message from the Devhelp builder (its 'epilog') for instructions, which typically involve creating a symlink: `mkdir -p $HOME/.local/share/devhelp/books && ln -s $PWD/path/to/build/devhelp $HOME/.local/share/devhelp/books/YourProjectName && devhelp`.
affects: All
Upgrade
Version history
2.0.0latest on PyPI · released Jul 29, 2024
Audit
Dependencies
SphinxrequiredCore dependency for Sphinx extensions; required for building documentation.