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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.7.14.tar.gz
  • Upload date:
  • Size: 183.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sphinx_literalizer-2026.7.14.tar.gz
Algorithm Hash digest
SHA256 1e1951902b7a87aa2d2e7a2e124efb6b741dec68e6b4ea8c1006b9797ca28a2d
MD5 01f5b87f79b7de803fcad04f5de56a83
BLAKE2b-256 a5b0da0f5f0d96c39bb60d1f3f1893bbb8dc08babbb6a45a23b51c361cc3978d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.7.14-py3-none-any.whl
Algorithm Hash digest
SHA256 68095c0a98de379d957972f8be387f40e08e5019265eab6c56fd6e5e23e62853
MD5 97ea318c60f60b047ff2761ce128f2c1
BLAKE2b-256 3541752ef3d6fae64346d23462c5f96a11203788deafddf656e063d615f0214c

See more details on using hashes here.

Provenance

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