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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.7.21.1.tar.gz
  • Upload date:
  • Size: 186.9 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.1.tar.gz
Algorithm Hash digest
SHA256 859bf8d3bbefb14ee1ccfe8101db967e8b9f041c08adc45735eba7d7e8b043e5
MD5 efcffdbec09b926674f0446a2a053003
BLAKE2b-256 b31be50a7b550f830bbe4a3c978c1ddfe9f2cdbd44d748875e290d35527652e4

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.7.21.1-py3-none-any.whl
Algorithm Hash digest
SHA256 28841698d75c52aec2c6b44a5ea7512c841baf0f98df6e72625681d1f66b7560
MD5 d15281f7a2ea5fb684164c8dff4ba053
BLAKE2b-256 6a7e8c5ec1c15a02ee6f3b17b9541d9d2e2316eeb8f99ee36f11a8e1e2014792

See more details on using hashes here.

Provenance

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