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.22.1.tar.gz (189.1 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.22.1-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.7.22.1.tar.gz
  • Upload date:
  • Size: 189.1 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.22.1.tar.gz
Algorithm Hash digest
SHA256 475ab2847d0433d92bc64cc79714eb46a1ae22075e13078c3fd61211774ed603
MD5 110467e6215f0288546b58a647979b6d
BLAKE2b-256 fb70a93f47ec431c13afca387f2bd584cb100d4de07fe838835bf9392ec8a346

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_literalizer-2026.7.22.1.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.22.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_literalizer-2026.7.22.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2a7e7591841ebc7e9da468a34b8545b10f8e9d14c10060ad885d93be44b2434d
MD5 2e97949438180f9380eea391308651d4
BLAKE2b-256 c7536a14731939af2dada69563b9bdf5f5d88870730f60508020a7a124ddfcd6

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_literalizer-2026.7.22.1-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