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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.7.15.tar.gz
  • Upload date:
  • Size: 184.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sphinx_literalizer-2026.7.15.tar.gz
Algorithm Hash digest
SHA256 16291a75849f590c2e66b08c89223a9e4223dd11b24c090f57b132c182fe0034
MD5 cf0d0fd9a9365b1cd9961ef77a92e116
BLAKE2b-256 38aead7a78d3869cf26927ab1ea162be6734e32c6ff2ac8ee4348e08a21667f8

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.7.15-py3-none-any.whl
Algorithm Hash digest
SHA256 124b9895d0094ab99cc7d13098b1f4e8b6c3373242a94dc5dc5cc04818240bd3
MD5 ce4271949fd093009fb8e6b8209414df
BLAKE2b-256 714d18e9b543443d9fb63a1c61e38a2c3219e1f2ee9949ae48976fe5f4a59520

See more details on using hashes here.

Provenance

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