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.24.2.tar.gz (191.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.24.2-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.7.24.2.tar.gz
  • Upload date:
  • Size: 191.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.24.2.tar.gz
Algorithm Hash digest
SHA256 f67418fd318b774ac2bbda2182575622c9b9c6dd8bf194a93bf0e33494cfa8fb
MD5 651fceaca9d943f08dc241373f4ed60c
BLAKE2b-256 89c81b887d24d3c0bb30f4bf458508d00213598321905d40063d9244b15a2880

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.7.24.2-py3-none-any.whl
Algorithm Hash digest
SHA256 39d8c66136f8679f2b7cd06166b513ffd182ef18b8b82432fd5a1d0c6b6d9564
MD5 0beb2ef6deaaec468eac44d246e65d7e
BLAKE2b-256 5a5ab4df8feb0c6538a2a59f7b837c39dfa3a6c5b8f1cd10425334a0648ef526

See more details on using hashes here.

Provenance

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