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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_literalizer-2026.7.20.tar.gz (186.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_literalizer-2026.7.20-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_literalizer-2026.7.20.tar.gz.

File metadata

  • Download URL: sphinx_literalizer-2026.7.20.tar.gz
  • Upload date:
  • Size: 186.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for sphinx_literalizer-2026.7.20.tar.gz
Algorithm Hash digest
SHA256 bfb37d1c8e6194d21a2520a61461539c268dff11a9c672fdc46ea111321845f2
MD5 0448c67b8474d23d619a2b6111056fad
BLAKE2b-256 7e302dec662f72f09b07c847d8483991b2b1382665f506ae62101697f19a822f

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_literalizer-2026.7.20.tar.gz:

Publisher: release.yml on adamtheturtle/sphinx-literalizer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinx_literalizer-2026.7.20-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_literalizer-2026.7.20-py3-none-any.whl
Algorithm Hash digest
SHA256 8a06a15578f39b93683fe045e479c6753e0906af9ed0a9e339e3674be7353171
MD5 4ba318107cd9b08203be98bbc63735bc
BLAKE2b-256 8b70a64a7a9b2f20537e08dbf3c69f7e7049bd9837d83af83e0e87496304fd8b

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_literalizer-2026.7.20-py3-none-any.whl:

Publisher: release.yml on adamtheturtle/sphinx-literalizer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page