Skip to main content

JSON Schema renderer for Sphinx

Project description

A JSON Schema renderer for Sphinx


As simple as it can be with pip:

pip install sphinx-json-schema


Add the extension name to your

extensions = [

If necessary, add a root directory to look for json schemas:

json_schema_root_dir = os.path.join('path', 'to', 'root', 'dir')

In your documentation:

.. json-schema:: path/to/json/schema.json

The file is looked up relatively from the .rst file the directive is called in, or, if not found from the json_schema_root_dir specified in the file.

allOf, oneOf, anyOf, not support

sphinx_json_schema supports the allOf, oneOf, anyOf and not keywords. It can also parse references to other schemas. The final JSON output is the result of the operations and inclusions of other schemas. This means it can be quite long even if the original .json file is very short!


This is still experimental

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_json_schema-0.2.tar.gz (7.4 kB view hashes)

Uploaded source

Built Distribution

sphinx_json_schema-0.2-py3-none-any.whl (10.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page