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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.8.2.tar.gz
  • Upload date:
  • Size: 194.3 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.2.tar.gz
Algorithm Hash digest
SHA256 c153a9fa22d476637a8f40e51e9aa75c3fb9ee0d42c476e411c11cfb2a1f7fde
MD5 b3e9e80aab75e5c305f357269ac9ce5d
BLAKE2b-256 39ddf50549d7a5c40fcb0d51f4a8da6d80a4d09ad073b77bbf673722829ba933

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d347426acfd43d88ac1a9fd4183d44ee0b4e220674d635f9590c0b62abef0ec9
MD5 e1d4ec8f2752c0060bbaafe035472aff
BLAKE2b-256 5b348e460b0fa841ce46c1f9d52666e2a87cad6830557357299d2de0063bdd4b

See more details on using hashes here.

Provenance

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