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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.7.21.tar.gz
  • Upload date:
  • Size: 186.6 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.tar.gz
Algorithm Hash digest
SHA256 2feae6fed9b457ca3cbf117ba53a8c485822f62672625afc9e3b0247aea65fc9
MD5 bae791256e06107be7c363e2df911c32
BLAKE2b-256 879b88fd29eefc4aa65718651f692fe492280bb0ee99852e667138fe8a5752fe

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.7.21-py3-none-any.whl
Algorithm Hash digest
SHA256 f3907959eb97881a3a74cdc567677a81abdd84f4ca30a4a92f329da42acd48dd
MD5 f67be83a749965c7f3d4e551e66a273c
BLAKE2b-256 88f3b96a3894204732bad16a0da156475d942bef9b6b5fdaf38f8cbfa48f22f9

See more details on using hashes here.

Provenance

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