sphinxcontrib-httpdomain
Sphinx extension that provides a domain for documenting HTTP APIs.
Decision gist · record as of 2026-08-14
Yes, if you are already using Sphinx and need HTTP API documentation markup. The low install friction, permissive license, and Production/Stable status make it a straightforward choice for Sphinx-based projects. However, verify that its feature set and syntax match your API documentation needs, and be aware that maintenance is aging—check whether active alternatives or community forks better suit modern workflows.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx to be installed and a Sphinx project structure (conf.py, .rst files).
- Low friction install with a single runtime dependency on sphinx.
- Maintenance status is aging (191 days since last release), though the package is marked Production/Stable and supports current Python versions through 3.14.
License · maintenance · safety
BSD-2-Clause (permissive) — BSD-2-Clause permissive license allows commercial and private use with minimal restrictions.
last release 2026-02-04 (191 days)
0 known vulnerabilities (OSV.dev, 2026-08-14) · 3,535,827 downloads/mo, #2,588 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-httpdomain
# In conf.py:
extensions = ['sphinxcontrib.httpdomain']
# In .rst file:
.. http:get:: /api/users
:synopsis: Retrieve user list- Whether the HTTP domain syntax and features remain compatible with recent Sphinx versions despite aging maintenance status.
- Whether this package is actively maintained or if community forks have superseded it for modern API documentation workflows.
What it is and what it does
sphinxcontrib-httpdomain is a Sphinx extension that adds a domain for documenting HTTP APIs. It lets you use structured markup directives to describe HTTP endpoints, methods, parameters, and responses within Sphinx documentation, generating cross-referenced API reference pages.
The package depends only on sphinx and installs with low friction. It's classified as Production/Stable and supports Python 3.10 through 3.14. However, maintenance is aging—the last release was 191 days ago—so while it works with current Python versions, you should verify that its HTTP domain syntax and feature set align with your documentation workflow before adopting it for new projects.
Use it for
- Generate structured API reference documentation for REST services within Sphinx projects.
- Document HTTP endpoints with method signatures, parameters, and response codes in a single domain.
- Cross-reference HTTP resources and endpoints within larger technical documentation.
- Build API docs that integrate with existing Sphinx-based project documentation.
- Maintain HTTP API documentation alongside other project docs in version control.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you are already using Sphinx and need HTTP API documentation markup.
The low install friction, permissive license, and Production/Stable status make it a straightforward choice for Sphinx-based projects. However, verify that its feature set and syntax match your API documentation needs, and be aware that maintenance is aging—check whether active alternatives or community forks better suit modern workflows.
Install
sphinxcontrib-httpdomain on PyPI
Before you install
Low friction install with a single runtime dependency on sphinx. Maintenance status is aging (191 days since last release), though the package is marked Production/Stable and supports current Python versions through 3.14.
Requires Sphinx to be installed and a Sphinx project structure (conf.py, .rst files).
License in practice
BSD-2-Clause permissive license allows commercial and private use with minimal restrictions.
Quickstart
pip install sphinxcontrib-httpdomain
# In conf.py:
extensions = ['sphinxcontrib.httpdomain']
# In .rst file:
.. http:get:: /api/users
:synopsis: Retrieve user listVerify before relying
- Whether the HTTP domain syntax and features remain compatible with recent Sphinx versions despite aging maintenance status.
- Whether this package is actively maintained or if community forks have superseded it for modern API documentation workflows.
Package facts
| License | BSD-2-Clause permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagesphinx |
| Maintenance | Aging 191 days since the last release |
| First released | |
| Downloads | 3,535,827 / month, #2,588 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 :: Sphinx :: DomainFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: BSD LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Utilities |
Evidence: sphinxcontrib_httpdomain-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 http api documentation”
- sphinxcontrib-httpdomainProvides a Sphinx domain for documenting HTTP APIs with structured…
- sphinxcontrib-openapiSphinx extension that renders OpenAPI (Swagger) specifications into…
- sphinx_tippyAdds interactive tooltips to Sphinx documentation using the Tippy.js…
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-openapi · Sphinx · sphinxcontrib-autoyaml · sphinxcontrib-confluencebuilder · sphinx_design · changelog · sphinxcontrib-apidoc · sphinx-inline-tabs · docstring-to-markdown · sphinxcontrib-serializinghtml