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.12.tar.gz (190.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.12-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.8.12.tar.gz
  • Upload date:
  • Size: 190.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.12.tar.gz
Algorithm Hash digest
SHA256 c8ac9e5c4fe94aedc2b951aa341633a1d3d7b501aa45eec4fa64927fe311c661
MD5 cc1cab70558dc532b5d841aa88475df1
BLAKE2b-256 d5d813bdaa426d4874e65b07c25f05772fa03c41fa38bfdc1d803093da4aa9c4

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.8.12-py3-none-any.whl
Algorithm Hash digest
SHA256 33724c1c0dbf0804108f3cf72bcc60a3da668afee7d08717faa31e23223a7f77
MD5 d12de817e414dd9c526ce7719434ab0b
BLAKE2b-256 4cdbb62edb5d548c3f481c9952892f66ec3f865e20536e8bab0e3aee757e9f7a

See more details on using hashes here.

Provenance

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