Skip to main content

sphinx-config-schema

License PyPI package Supported Python versions pre-commit.ci status CI status 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.1

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.1
File Size Uploaded Provenance Actions
sphinx_config_schema-0.0.1.tar.gz 30.0 kB With provenance Details for sphinx_config_schema-0.0.1.tar.gz

Built distribution (wheel)

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

Total release size: 41.3 kB

Release files / sphinx_config_schema-0.0.1.tar.gz

Download URL sphinx_config_schema-0.0.1.tar.gz
Size 30.0 kB
Tags Source
SHA-256 checksum
How to use checksums
e40677838e3226914fd47a17654a5300394c1b22f4b00e12d5843ecc121258e2
BLAKE2b-256 checksum
How to use checksums
fb280cf7f8c498c2f5ff5b6d26ddba6f833eca97fc1a5ce003c7e1059ae927e2
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 Oct 29, 2026.

Transparency log

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

Download URL sphinx_config_schema-0.0.1-py3-none-any.whl
Size 11.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8b86dc00f625d6fae644854e1a369b089c114cab0325a36df09fe11fd45be8e9
BLAKE2b-256 checksum
How to use checksums
78361d2464b69d671841ee551b479eb43cccbe3c8f451e8c4c72c6d1252b3ef6
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 Oct 29, 2026.

Transparency log

Security for sphinx-config-schema 0.0.1

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.1.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 Oct 29, 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