sphinx-jsonschema
Sphinx extension to display JSON Schema
Decision gist · record as of 2026-08-14
Yes, with conditions. The extension is stable and feature-complete for JSON Schema Draft 4 documentation, with no known vulnerabilities. However, the abandoned maintenance status and archived repository mean no future bug fixes or Sphinx compatibility updates are guaranteed. Install only if your Sphinx version is compatible with 1.19.2 and you do not expect ongoing support.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx to be installed and a working Sphinx documentation project; the extension must be added to the extensions list in conf.py to function.
- High install friction: the package has no runtime dependencies but is marked abandoned with an archived repository.
- The last commit is recent (2025-12-01), but the maintenance status is abandoned, meaning bug fixes and compatibility updates are unlikely.
License · maintenance · safety
GPLv3 (copyleft) — Licensed under GPLv3 (copyleft). Any project that distributes documentation built with this extension must comply with GPLv3 terms, including source disclosure if the extension is modified or bundled.
last release 2025-12-01 (256 days) · last repo commit 2025-12-01 · 83 stars · archived
0 known vulnerabilities (OSV.dev, 2026-08-14) · 186,502 downloads/mo, #9,984 on PyPI
Alternatives
Verify before relying
pip install sphinx-jsonschema
In conf.py:
extensions = ['sphinx-jsonschema']
In your .rst file:
.. jsonschema:: http://some.domain/spec.json
Or inline:
.. jsonschema::
{"type": "string", "minLength": 10}- Compatibility with Sphinx 9.0 and later versions beyond the reported fix in 1.19.2
- Whether the abandoned status affects long-term stability or if the package is feature-complete and stable enough for production use
- Support for JSON Schema Draft 7 and later versions beyond the stated 'examples' keyword support
What it is and what it does
sphinx-jsonschema is a Sphinx documentation extension that lets you embed and render JSON Schema definitions directly in your documentation. You can reference schemas from URLs, local files, or Python objects, and use JSON Pointer notation to display subschemas. The extension supports inline reStructuredText markup in schema titles and descriptions, and includes custom extensions like $$target for cross-references and $$description for multi-line descriptions.
The package has been in development since 2017-01-29 and implements most JSON Schema Draft 4 features plus the examples keyword from Draft 7. It has no runtime dependencies beyond Sphinx itself, but the repository is now archived and marked abandoned, meaning maintenance and compatibility updates are no longer active.
Use it for
- Embed API specification schemas in REST API documentation for developers to understand request/response structures
- Display configuration file schema definitions in project documentation to guide users on valid settings
- Reference shared schema definitions across multiple documentation pages using JSON Pointer and cross-references
- Render complex nested schemas with formatted descriptions and tables using reStructuredText markup
- Load schemas from external URLs or files to keep documentation in sync with canonical schema definitions
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, with conditions.
The extension is stable and feature-complete for JSON Schema Draft 4 documentation, with no known vulnerabilities. However, the abandoned maintenance status and archived repository mean no future bug fixes or Sphinx compatibility updates are guaranteed. Install only if your Sphinx version is compatible with 1.19.2 and you do not expect ongoing support.
Install
sphinx-jsonschema on PyPI
Before you install
High install friction: the package has no runtime dependencies but is marked abandoned with an archived repository. The last commit is recent (2025-12-01), but the maintenance status is abandoned, meaning bug fixes and compatibility updates are unlikely.
Requires Sphinx to be installed and a working Sphinx documentation project; the extension must be added to the extensions list in conf.py to function.
License in practice
Licensed under GPLv3 (copyleft). Any project that distributes documentation built with this extension must comply with GPLv3 terms, including source disclosure if the extension is modified or bundled.
Quickstart
pip install sphinx-jsonschema
In conf.py:
extensions = ['sphinx-jsonschema']
In your .rst file:
.. jsonschema:: http://some.domain/spec.json
Or inline:
.. jsonschema::
{"type": "string", "minLength": 10}Verify before relying
- Compatibility with Sphinx 9.0 and later versions beyond the reported fix in 1.19.2
- Whether the abandoned status affects long-term stability or if the package is feature-complete and stable enough for production use
- Support for JSON Schema Draft 7 and later versions beyond the stated 'examples' keyword support
Package facts
| License | GPLv3 copyleft |
| Python support | Not specified |
| Install friction | High. Source build required |
| Runtime dependencies | None |
| Maintenance | Abandoned 256 days since the last release |
| Last repo commit | repository archived |
| First released | |
| Downloads | 186,502 / month, #9,984 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaEnvironment :: PluginsFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: GNU General Public License v3 (GPLv3)Operating System :: OS IndependentProgramming Language :: Python :: 3Topic :: Documentation :: SphinxTopic :: Software Development :: Documentation |
Evidence: sphinx_jsonschema-1.19.2.tar.gz
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 json schema documentation”
- sphinx-jsonschemaA Sphinx extension that renders JSON Schema definitions inline or…
- sphinxcontrib.datatemplatesA Sphinx extension that renders reStructuredText documentation…
- sphobjinvInspect, search, and manipulate Sphinx objects.inv inventory files…
Give your agent the search over MCP, or paste the wish link into any chat.
More Sphinx packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
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…
See also marshmallow-jsonschema · json-ref-dict · sphinx_mdinclude · sphinxcontrib.datatemplates · jsonschema-specifications · jsonschema-spec · referencing · jschon · sphinx-data-viewer · GitHubKit-schemas