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

Built distribution (wheel)

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

Total release size: 218.3 kB

Release files / sphinx_literalizer-2026.9.1.tar.gz

Download URL sphinx_literalizer-2026.9.1.tar.gz
Size 199.0 kB
Tags Source
SHA-256 checksum
How to use checksums
04f949b5041efbb055036ddf353843e2b1f26b02f9ab4fc4351821185174bd3e
BLAKE2b-256 checksum
How to use checksums
16555651de04d2b14d05bb7dc39d3224fed941ebb6a8fca602b801d41c8e7250
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 1, 2026.

Transparency log

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

Download URL sphinx_literalizer-2026.9.1-py3-none-any.whl
Size 19.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3f07791ee51eaa5f39afda4d5ec64c66d701dcf5bf21e5412d48bf464a25fac3
BLAKE2b-256 checksum
How to use checksums
e0c2fed4a722e024de923b0a9cb0c63cdb2f7611bfe20bafcd1e700d25a8aa9a
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 1, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

2026.9.1 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