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

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.9.4
File Size Uploaded
sphinx_literalizer-2026.9.4.tar.gz 199.0 kB Details

Built distribution (wheel)

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

Total release size: 218.4 kB

Release files / sphinx_literalizer-2026.9.4.tar.gz

Download URL sphinx_literalizer-2026.9.4.tar.gz
Size 199.0 kB
Tags Source
SHA-256 checksum
How to use checksums
590d8fd923c9c8fed531b536e06ff37fcb0c452e00aa63536fd3d20ca6cef414
BLAKE2b-256 checksum
How to use checksums
aab7b9abb2ee6d118110e7f2f39b1210f187e6590f8d5db2cac7222c25b1a9df
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 Sep 4, 2026.

Transparency log

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

Download URL sphinx_literalizer-2026.9.4-py3-none-any.whl
Size 19.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6d71edba3887dad64b70e2275289ece3b06f9662bd432d73a3424eb5dcf29a7a
BLAKE2b-256 checksum
How to use checksums
6418548dcc72b3cae42c5be89fa01c66f89c3799ff3f148980191a8d39724a43
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 Sep 4, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

2026.9.4 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