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.13.tar.gz (192.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.8.13-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.8.13.tar.gz
  • Upload date:
  • Size: 192.7 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.13.tar.gz
Algorithm Hash digest
SHA256 09c189a5e5393b2a890d7f963decddd8dd426b475dbcc8e945d2df1343c70c3b
MD5 00ecb57f2e57d1c9a70ccb953f732d4f
BLAKE2b-256 2672b76f991d726cd1fa05f9d3a7d03159c790b8c4a49b35994e361eff3442fb

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.8.13-py3-none-any.whl
Algorithm Hash digest
SHA256 31e30b46e3db45b0e3cd99d7e50a0a59002f66fc6e0601bae71230fcd660d14c
MD5 ecc23e21a3dd358508e9a0b60b3c89aa
BLAKE2b-256 55f1f04a4702907e5d2729e93b0a53736c0379444e3b9f56ab9c42332b65e9d7

See more details on using hashes here.

Provenance

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