sphinxcontrib-websupport
sphinxcontrib-websupport provides a Python API to easily integrate Sphinx documentation into your Web application
Decision gist · record as of 2026-08-14
Yes, if you need to serve Sphinx documentation from a web application backend. The low install friction and permissive license make it straightforward to adopt. However, the aging maintenance status (746 days since last release) means you should verify compatibility with your target Sphinx version and be prepared to handle any issues independently or contribute fixes upstream.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.9 or later; Sphinx and its dependencies must be installed.
- Low friction install as a pure Python wheel.
- Maintenance is aging—last release was 746 days ago—but the repository remains active and marked Production/Stable.
License · maintenance · safety
permissive license (permissive) — Licensed under BSD (permissive), meaning you can use, modify, and distribute it freely with minimal restrictions.
last release 2024-07-29 (746 days) · last repo commit 2025-05-01 · 11 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 1,355,661 downloads/mo, #4,006 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-websupport
import sphinxcontrib.websupport
app = sphinxcontrib.websupport.WebSupport(srcdir='source', builddir='build')- Whether the package still works reliably with current Sphinx versions, given the 746-day gap since last release
- What specific web framework integrations or examples are documented beyond the API itself
- Performance characteristics when serving documentation to concurrent users
What it is and what it does
sphinxcontrib-websupport is a Sphinx extension that exposes a Python API for embedding Sphinx documentation into web applications. Rather than serving static HTML, it lets you integrate live, searchable documentation directly into your web stack. It depends on Sphinx itself, Jinja2 for templating, and sphinxcontrib-serializinghtml for document serialization.
The package is positioned as a bridge between Sphinx's documentation generation and web application frameworks. It handles the server-side logic needed to serve documentation interactively—particularly search functionality—rather than as flat files. This is useful when you want documentation to feel native to your application rather than a separate portal.
Use it for
- Embed searchable Sphinx documentation directly into a web application's help or docs section
- Build a custom documentation portal that integrates with your application's authentication and UI
- Serve dynamically generated or versioned documentation from a web backend
- Add full-text search over Sphinx docs without hosting a separate documentation site
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you need to serve Sphinx documentation from a web application backend.
The low install friction and permissive license make it straightforward to adopt. However, the aging maintenance status (746 days since last release) means you should verify compatibility with your target Sphinx version and be prepared to handle any issues independently or contribute fixes upstream.
Install
sphinxcontrib-websupport on PyPI
Before you install
Low friction install as a pure Python wheel. Maintenance is aging—last release was 746 days ago—but the repository remains active and marked Production/Stable.
Requires Python 3.9 or later; Sphinx and its dependencies must be installed.
License in practice
Licensed under BSD (permissive), meaning you can use, modify, and distribute it freely with minimal restrictions.
Quickstart
pip install sphinxcontrib-websupport
import sphinxcontrib.websupport
app = sphinxcontrib.websupport.WebSupport(srcdir='source', builddir='build')Verify before relying
- Whether the package still works reliably with current Sphinx versions, given the 746-day gap since last release
- What specific web framework integrations or examples are documented beyond the API itself
- Performance characteristics when serving documentation to concurrent users
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagesjinja2Sphinxsphinxcontrib-serializinghtml |
| Maintenance | Aging 746 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 1,355,661 / month, #4,006 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_websupport-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 web integration”
- sphinxcontrib-websupportProvides a Python API to integrate Sphinx-generated documentation…
- sphinx-commentsIntegrates third-party commenting and annotation services into…
- sphinx-basic-ngProvides a modern, minimal Sphinx theme skeleton for building custom…
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-htmlhelp · sphinx-comments · sphinxcontrib-devhelp · sphinxcontrib-serializinghtml · sphinxcontrib-applehelp · sphinxcontrib-qthelp · Sphinx · sphinxcontrib-googleanalytics · sphinx-autoapi · sphinxcontrib-openapi