A JSON Schema renderer for Sphinx
Installation
As simple as it can be with pip:
pip install sphinx-json-schema
Usage
Add the extension name to your conf.py:
extensions = [ ... 'sphinx_json_schema_formatter', ... ]
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 conf.py file.
allOf, oneOf, anyOf, not support
sphinx_json_schema_formatter 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!
1 maintainer
Metadata
1 maintainer
Release files for sphinx-json-schema-formatter 0.3.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sphinx_json_schema_formatter-0.3.7.tar.gz | 7.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_json_schema_formatter-0.3.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 18.2 kB
Release files / sphinx_json_schema_formatter-0.3.7.tar.gz
| Download URL | sphinx_json_schema_formatter-0.3.7.tar.gz |
|---|---|
| Size | 7.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1c3f25cbd30458311e43a26d56d7b8e8dbf047c41602d2f3a02b589b5bf05f77
|
|
BLAKE2b-256 checksum How to use checksums |
e0b90aa7419ed2cdb7ed923300dc1c3c992db69c16e24c0326d5e67647fc71f0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6
|
Release files / sphinx_json_schema_formatter-0.3.7-py3-none-any.whl
| Download URL | sphinx_json_schema_formatter-0.3.7-py3-none-any.whl |
|---|---|
| Size | 10.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
74627436fcd97de10b6b35f1c8772ca2a931c8494eec14c53277fb043ac7d2fe
|
|
BLAKE2b-256 checksum How to use checksums |
9defedad7dc20d5d1a7d18483b47a0a55b6836b42038f2a594c52e16eef775fa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6
|
Security for sphinx-json-schema-formatter 0.3.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
