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

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.27
File Size Uploaded
sphinx_literalizer-2026.8.27.tar.gz 198.2 kB Details

Built distribution (wheel)

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

Total release size: 217.5 kB

Release files / sphinx_literalizer-2026.8.27.tar.gz

Download URL sphinx_literalizer-2026.8.27.tar.gz
Size 198.2 kB
Tags Source
SHA-256 checksum
How to use checksums
1394d47aab56d2224691cb3e6373f38cc30579d72ff4e686b5481bba50b98d4c
BLAKE2b-256 checksum
How to use checksums
9cfc7f7f9c137f2324de6c25da2d07f48a6f1c1260c8827e055b6fc22adc888e
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 27, 2026.

Transparency log

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

Download URL sphinx_literalizer-2026.8.27-py3-none-any.whl
Size 19.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ab48f2036bc9548bd111691e4772798bd783eed055f0f67377a60a642ab4ae01
BLAKE2b-256 checksum
How to use checksums
4b215af47393b83283c951e5d83fb614518ffa5a56dfd047e08e1feee116c6f1
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 27, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

2026.8.27 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