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.8.14.tar.gz (195.4 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.8.14-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_literalizer-2026.8.14.tar.gz
Algorithm Hash digest
SHA256 593abfa6e999de4adc30396bacb7b5912f2c7a0cf26cc65c6ae46c340b000e76
MD5 96464ce11b3a14e6d3e33913943bec61
BLAKE2b-256 c1a1adf823eb04ddc0b761b6c25e60ed4393769bbb167fe95f23e124dc59e033

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.8.14-py3-none-any.whl
Algorithm Hash digest
SHA256 5cfded91138a45fb373806fef166a0fa77c26294a591ce71b62dbdafe9253074
MD5 f329d0b9aeb28e33e62bd392fc53635f
BLAKE2b-256 8aa18be2f4ca4f33c3abc5dfa68058735bcd0bc8c90842406bb06d7d6d241b9a

See more details on using hashes here.

Provenance

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