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.21.2.tar.gz (187.3 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.21.2-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.7.21.2.tar.gz
  • Upload date:
  • Size: 187.3 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.21.2.tar.gz
Algorithm Hash digest
SHA256 990b53b37bf29cc262fa740de2ff00afa9277f5721de60d40bf65c6542ac8e4a
MD5 0bc8ba9cf414bec5c2404c5fe928f33a
BLAKE2b-256 ce6eaec1aa48a5d53dfe601dbd5f0f671692a7140438e8102d374759cf6552e5

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.7.21.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9d843ade8398c7defb3a8dd065b4419ab1825af73f50629dee7eeef86a88ef7b
MD5 69f1d7ffd8a114795b51e4a7383597c0
BLAKE2b-256 b4a7e70b19216414c49488284852a9e664bd16a96de70cb8bf69d0ece64abc2b

See more details on using hashes here.

Provenance

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