Skip to main content

Sphinx extension to define data structure using JSON Schema

Project description

sphinxcontrib-opendataservices-jsonschema is Sphinx extension to define data structure using JSON Schema

Usage

Include this extension in conf.py:

extensions = ['sphinxcontrib.jsonschema']

Write jsonschema directive into reST file where you want to import schema:

.. jsonschema:: path/to/your.json

Docs

https://sphinxcontrib-opendataservices-jsonschema.readthedocs.io/en/latest/ , or see the docs folder in this repository

PyPi

Available at https://pypi.org/project/sphinxcontrib-opendataservices-jsonschema/

Don’t install this package and https://pypi.org/project/sphinxcontrib-jsonschema/ at the same time, as they use the same Python namespace.

History

This project was started as https://github.com/tk0miya/sphinxcontrib-jsonschema and forked by Open Data Services Co-operative in May 2020. Thanks to all the original authors.

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

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page