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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.7.24.tar.gz
  • Upload date:
  • Size: 190.8 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.tar.gz
Algorithm Hash digest
SHA256 3b2a3f349ee3a475c9a4b2bf0517cc32b96cfe6ccea9a53b5a3dd0aff61ddb9c
MD5 5de5deea77ebee7b2d2d36434ac93b33
BLAKE2b-256 5185d84a6353427842ecedb20139a2a59a8c41bb2bd178c78bf31ac54ddaa7fd

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.7.24-py3-none-any.whl
Algorithm Hash digest
SHA256 5a5ef6e576e4489118d3440f8985a30b418fc8ee2e722b5e729bd527e92601a6
MD5 b373bf4e954808245d380649c4698a04
BLAKE2b-256 e3643ecb9532ba514787092a7df3fadbfd5f015b8b94c1aaa376ffd30ab6f72f

See more details on using hashes here.

Provenance

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