Skip to main content

sphinx-config-schema

License PyPI package Supported Python versions pre-commit.ci status CI status Test coverage Spelling checked code style: prettier Ruff uv ty

sphinx-config-schema is a Sphinx extension that renders a JSON schema as a copyable TOML, YAML, or JSON example. Each key shows the description of its setting as a tooltip and links to itself as a permalink.

pip install sphinx-config-schema

Then add the extension to your conf.py:

extensions = [
    "sphinx_config_schema",
]

and render a schema in a reStructuredText page:

.. config-schema:: example.schema.json
    :caption: pyproject.toml
    :table: tool.example
    :format: toml

or in a MyST Markdown page:

```{config-schema} example.schema.json
:caption: pyproject.toml
:table: tool.example
:format: toml
```

See compwa.github.io/sphinx-config-schema for the documentation and a rendered example.

Metadata

Release files for sphinx-config-schema 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-config-schema 0.0.2
File Size Uploaded Provenance Actions
sphinx_config_schema-0.0.2.tar.gz 42.4 kB With provenance Details for sphinx_config_schema-0.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-config-schema 0.0.2
File Interpreter ABI Platform Actions
sphinx_config_schema-0.0.2-py3-none-any.whl Python 3 none any Details for sphinx_config_schema-0.0.2-py3-none-any.whl

Total release size: 61.7 kB

Release files / sphinx_config_schema-0.0.2.tar.gz

Download URL sphinx_config_schema-0.0.2.tar.gz
Size 42.4 kB
Tags Source
SHA-256 checksum
How to use checksums
89407dbdb29937a5c6711bb215a7036e81c53110d7db9b55e04689b6df3c45a0
BLAKE2b-256 checksum
How to use checksums
4479e28b5e6454589d6de3aacd2b78d91a46f64c7ddff7991aeedfa01f5885a3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 3, 2026.

Transparency log

Release files / sphinx_config_schema-0.0.2-py3-none-any.whl

Download URL sphinx_config_schema-0.0.2-py3-none-any.whl
Size 19.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1e2e1ceb7032ec830df4aa6b4ff74bcf0a14b4df05e3b0e9329abfca1de4117b
BLAKE2b-256 checksum
How to use checksums
ae951dda11a7fcf6b55d22f3f798cd6200a0425b2a300296a6f96d9abc3e506d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 3, 2026.

Transparency log

Security for sphinx-config-schema 0.0.2

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for sphinx_config_schema-0.0.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 3, 2026.

Transparency log

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.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page