Skip to main content

Build Status PyPI

sphinx-literalizer

sphinx-literalizer is a Sphinx extension for literalizer, which converts JSON, YAML, TOML, and JSON5 data structures to native language literal syntax (Python, TypeScript, Go, etc.).

Installation

Requires Python 3.12+.

pip install sphinx-literalizer

Usage

Add to your Sphinx conf.py:

extensions = [
    # ...
    "sphinx_literalizer",
]

Then use the literalizer directive in your .rst files:

.. literalizer:: path/to/data.json
   :language: python
   :wrap:

This reads the data file and renders its contents as a native Python literal in a code block. Input format is auto-detected from the file extension (.json, .yaml/.yml, .toml, .json5), or can be set explicitly with :input-format:.

Full documentation

See the full documentation for more information including how to contribute.

Metadata

Release files for sphinx-literalizer 2026.8.31

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-literalizer 2026.8.31
File Size Uploaded
sphinx_literalizer-2026.8.31.tar.gz 198.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinx-literalizer 2026.8.31
File Interpreter ABI Platform
sphinx_literalizer-2026.8.31-py3-none-any.whl Python 3 none any Details

Total release size: 218.1 kB

Release files / sphinx_literalizer-2026.8.31.tar.gz

Download URL sphinx_literalizer-2026.8.31.tar.gz
Size 198.7 kB
Tags Source
SHA-256 checksum
How to use checksums
20af9b6a7833812b615b30a49bd6d22d6fd2033b4556ac52c71a15d9b5d51078
BLAKE2b-256 checksum
How to use checksums
894065e5201c8d9b83c2daff622c517d79073ba3d59f435f9a1adabb51f6c37d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Aug 31, 2026.

Transparency log

Release files / sphinx_literalizer-2026.8.31-py3-none-any.whl

Download URL sphinx_literalizer-2026.8.31-py3-none-any.whl
Size 19.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ea6d22324899614206591ee978a1eb7115e3e27469ae34d25b599ae10d5f9dd3
BLAKE2b-256 checksum
How to use checksums
3c08f1dd64560a55c74032f6531fad83a4e4d8747ca0b17c9435d2e1e040f3fe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Aug 31, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

2026.8.31 This release

2 release files

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