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.1.tar.gz (193.5 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.1-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.8.1.tar.gz
  • Upload date:
  • Size: 193.5 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.1.tar.gz
Algorithm Hash digest
SHA256 8767c96513fd107e6c32debb03322fbcdfc09e5f391ecd0e9944464597e5f24f
MD5 6170483164fe8709f27c26468f530555
BLAKE2b-256 f48f454b00d392f0cdbd4a337b4a090057b3fa290284f8b0d4ff989a6a3d6a94

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1811b21d73259a5a119442dc6a515dc85b82b16c8c218c4d459d2499f81366d5
MD5 745cc2cebd183952300027f3896430e9
BLAKE2b-256 33143eda80f40398f008e4fec1725698d87b5a31b5e60a5aa405689cf5c9279b

See more details on using hashes here.

Provenance

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