sphinxcontrib-serializinghtml
sphinxcontrib-serializinghtml is a sphinx extension which outputs "serialized" HTML files (json and pickle)
Decision gist · record as of 2026-08-14
Yes, if you need serialized documentation output from Sphinx. The extension is stable, has no dependencies, and installs easily. The dormant maintenance status is acceptable for a narrow, well-defined tool that does one thing—be aware that updates will be infrequent if Sphinx internals change significantly.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python >=3.9 and an existing Sphinx documentation project.
- Low friction install with no runtime dependencies.
- Maintenance is dormant (746 days since last release), but the package is marked Production/Stable and the repository remains active with a recent commit on 2024-10-24.
License · maintenance · safety
permissive license (permissive) — Licensed under BSD (permissive), imposing no restrictions on use or redistribution.
last release 2024-07-29 (746 days) · last repo commit 2024-10-24 · 4 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 30,533,299 downloads/mo, #799 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-serializinghtml
In conf.py, add to extensions:
extensions = ['sphinxcontrib.serializinghtml']
Then build with: sphinx-build -b json source build/json- Whether JSON and pickle outputs are suitable for production documentation pipelines or primarily for development/debugging.
- Performance characteristics when serializing large documentation sets.
- Compatibility with recent Sphinx versions beyond those explicitly listed (3.9–3.13).
What it is and what it does
sphinxcontrib-serializinghtml is a Sphinx extension that generates documentation output in serialized formats—JSON and pickle—in addition to or instead of standard HTML. It integrates directly into Sphinx's build pipeline, allowing you to export your documentation structure and content in machine-readable formats.
The extension is useful when you need to programmatically process or redistribute documentation data, or when you want to build custom tooling on top of your Sphinx docs. It has no runtime dependencies beyond Sphinx itself, making it lightweight to add to an existing documentation build. The package is marked Production/Stable and supports Python 3.9 through 3.13, though maintenance is dormant (last release 2024-07-29, last commit 2024-10-24).
Use it for
- Export Sphinx documentation to JSON for consumption by custom web frontends or documentation portals.
- Serialize documentation structure and metadata for programmatic analysis or indexing.
- Generate pickle-format documentation archives for internal tooling or offline processing.
- Build documentation search or navigation systems that require structured data rather than HTML.
- Integrate Sphinx docs into a larger documentation pipeline that expects machine-readable formats.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you need serialized documentation output from Sphinx.
The extension is stable, has no dependencies, and installs easily. The dormant maintenance status is acceptable for a narrow, well-defined tool that does one thing—be aware that updates will be infrequent if Sphinx internals change significantly.
Install
sphinxcontrib-serializinghtml on PyPI
Before you install
Low friction install with no runtime dependencies. Maintenance is dormant (746 days since last release), but the package is marked Production/Stable and the repository remains active with a recent commit on 2024-10-24.
Requires Python >=3.9 and an existing Sphinx documentation project.
License in practice
Licensed under BSD (permissive), imposing no restrictions on use or redistribution.
Quickstart
pip install sphinxcontrib-serializinghtml
In conf.py, add to extensions:
extensions = ['sphinxcontrib.serializinghtml']
Then build with: sphinx-build -b json source build/jsonVerify before relying
- Whether JSON and pickle outputs are suitable for production documentation pipelines or primarily for development/debugging.
- Performance characteristics when serializing large documentation sets.
- Compatibility with recent Sphinx versions beyond those explicitly listed (3.9–3.13).
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 | 30,533,299 / month, #799 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_serializinghtml-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 serialized html output”
- sphinxcontrib-serializinghtmlA Sphinx extension that outputs documentation in serialized HTML…
- sphinxcontrib-htmlhelpA Sphinx extension that generates HTML help files from…
- sphinx-markdown-builderA Sphinx extension that generates Markdown output 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-htmlhelp · sphinxcontrib-devhelp · sphinxcontrib-websupport · sphinxcontrib-applehelp · sphinxcontrib-qthelp · Sphinx · sphinx-markdown-tables · sphinx-autodoc-typehints · sphinxcontrib-jsmath · sphinxcontrib-katex