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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.8.12.2.tar.gz
  • Upload date:
  • Size: 191.2 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.2.tar.gz
Algorithm Hash digest
SHA256 a881f7de013b0c15427f2f67af633bd01860b0a845183d51b7433254e3a841be
MD5 0b67cbf572f9f04814faef979617d9e7
BLAKE2b-256 4be57fc127d1f8ab6a3c64480736dcbb09dc304b985972890959002dedcece71

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.8.12.2-py3-none-any.whl
Algorithm Hash digest
SHA256 02ecf3a3c965a769a54109c891416e6e3f0a6ec194220c3b0dc5774c95527e6b
MD5 9b6a5817986a66a183a7fb4060885f86
BLAKE2b-256 34facd9ccd363529b24c05a6112c1aaca6fbac47a0dc3d6391a8e6800d5635f8

See more details on using hashes here.

Provenance

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