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.12.1.tar.gz (190.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.8.12.1-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.8.12.1.tar.gz
  • Upload date:
  • Size: 190.6 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.12.1.tar.gz
Algorithm Hash digest
SHA256 934fe19630e04fa43bc5577304c9b31efe48f5f9e75da8a48f796089895c88da
MD5 ae8de3d705a926e41e638b8624a7e5d9
BLAKE2b-256 3cc094acbedf000a4f9a66e03384393d00e2659e997def240b9f90abba969f7a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.8.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fa1c12f017bbe5158ea91a2cf84c5b93aa740faa9d405612b289fa34296f9b73
MD5 d912d1fc67ec9281f2640e686ce9d9c3
BLAKE2b-256 f410ed02fee9f18e5e4fee578aa0da036822917074d4a4634c7c670a32e8f1f0

See more details on using hashes here.

Provenance

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