sphinxcontrib-qthelp
sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp documents
Decision gist · record as of 2026-08-14
Yes, if you are building Qt-based applications and need to generate help files from Sphinx documentation. The extension is stable and has no dependencies, making installation straightforward. However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your use case.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.9 or later and an existing Sphinx documentation project.
- Low install friction with no runtime dependencies.
- Maintenance is dormant—last release was 746 days ago and the repository shows minimal activity, though it remains marked as production-stable and is not archived.
License · maintenance · safety
permissive license (permissive) — Licensed under a permissive BSD license, which allows commercial and private use with minimal restrictions.
last release 2024-07-29 (746 days) · last repo commit 2024-10-25 · 2 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 27,648,827 downloads/mo, #853 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-qthelp
Then add to your Sphinx conf.py:
extensions = ['sphinxcontrib.qthelp']
Build with: sphinx-build -b qthelp source/ build/qthelp- Whether QtHelp output format remains actively used or supported in modern Qt tooling.
- Compatibility with recent Sphinx versions beyond the stated Python 3.9–3.13 support.
- Whether dormant maintenance poses risk for future Sphinx API changes.
What it is and what it does
sphinxcontrib-qthelp is a Sphinx extension that generates QtHelp format output from reStructuredText documentation. It bridges Sphinx's documentation toolchain with Qt's help system, allowing developers to produce help files compatible with Qt Assistant and other Qt-based help viewers.
The extension has no runtime dependencies and integrates directly into Sphinx's build pipeline. It is marked as production-stable and supports Python 3.9 through 3.13, but maintenance is dormant—the last release occurred 746 days ago. This means it works reliably for its intended purpose but will not receive updates for new Sphinx features or Python versions without community intervention.
Use it for
- Generate integrated help documentation for Qt-based desktop applications from Sphinx source.
- Convert existing Sphinx documentation projects to QtHelp format for distribution with Qt software.
- Build offline help systems compatible with Qt Assistant for end-user documentation.
- Maintain a single documentation source that outputs to both web (HTML) and Qt help formats.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you are building Qt-based applications and need to generate help files from Sphinx documentation.
The extension is stable and has no dependencies, making installation straightforward. However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your use case.
Install
sphinxcontrib-qthelp on PyPI
Before you install
Low install friction with no runtime dependencies. Maintenance is dormant—last release was 746 days ago and the repository shows minimal activity, though it remains marked as production-stable and is not archived.
Requires Python 3.9 or later and an existing Sphinx documentation project.
License in practice
Licensed under a permissive BSD license, which allows commercial and private use with minimal restrictions.
Quickstart
pip install sphinxcontrib-qthelp
Then add to your Sphinx conf.py:
extensions = ['sphinxcontrib.qthelp']
Build with: sphinx-build -b qthelp source/ build/qthelpVerify before relying
- Whether QtHelp output format remains actively used or supported in modern Qt tooling.
- Compatibility with recent Sphinx versions beyond the stated Python 3.9–3.13 support.
- Whether dormant maintenance poses risk for future Sphinx API changes.
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | None |
| Maintenance | Dormant 746 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 27,648,827 / month, #853 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | 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 |
Evidence: sphinxcontrib_qthelp-2.0.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx qthelp output format”
- sphinxcontrib-qthelpA Sphinx extension that converts documentation source files into…
- sphinxcontrib-devhelpA Sphinx extension that generates Devhelp documentation output…
- sphinxcontrib-applehelpSphinx extension that generates Apple help books from…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also sphinxcontrib-devhelp · sphinxcontrib-applehelp · sphinxcontrib-htmlhelp · linuxdoc · sphinx-argparse · sphinx-simplepdf · sphinxcontrib-websupport · sphinxcontrib-confluencebuilder · sphinxcontrib-serializinghtml · sphinx-llm