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.3

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.3
File Size Uploaded Provenance Actions
sphinx_config_schema-0.0.3.tar.gz 43.3 kB With provenance Details for sphinx_config_schema-0.0.3.tar.gz

Built distribution (wheel)

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

Total release size: 62.9 kB

Release files / sphinx_config_schema-0.0.3.tar.gz

Download URL sphinx_config_schema-0.0.3.tar.gz
Size 43.3 kB
Tags Source
SHA-256 checksum
How to use checksums
6e3329260f687b965fb3f747edf0376403ac9634931582a21e8151438e785568
BLAKE2b-256 checksum
How to use checksums
3a198b42e600959b3e3162df3d49a6a018f848a481c672992490d3922cd4f704
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.3-py3-none-any.whl

Download URL sphinx_config_schema-0.0.3-py3-none-any.whl
Size 19.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
94450d3e7625f747f36f01063c73dfaf7289b8c478e9ce665516e5d5a5274bf4
BLAKE2b-256 checksum
How to use checksums
adc5f7550c97c6e967ba4923bd30b6a7b77a4fc327d366f4dba87abc18c6650b
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.3

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.3.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