sphinxcontrib-websupport

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

Provides a Python API to integrate Sphinx-generated documentation into web applications, enabling server-side search and interactive documentation features.

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

pip install sphinxcontrib-websupport

uv add sphinxcontrib-websupport

poetry add sphinxcontrib-websupport

Installing sphinxcontrib-websupport

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.

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')

Requires Python 3.9 or later; Sphinx and its dependencies must be installed.

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

Evidence: sphinxcontrib_websupport-2.0.0-py3-none-any.whl

Tags

More Utilities packages