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.13.1.tar.gz (193.4 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.13.1-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.8.13.1.tar.gz
  • Upload date:
  • Size: 193.4 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.13.1.tar.gz
Algorithm Hash digest
SHA256 6723abc6ed67e83e6c18bb688c3a3c187261eadeec5f865ba9841f0c33e78282
MD5 7de35d6c1b498187fd957b71f59eed3a
BLAKE2b-256 1b27e284577472b2ba7768ebd9077acc91844a52008f04081172d8d4f88de95f

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.8.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 354aba5b1511f130f60a5ec5c88c8fbf6cb66127b71ef2f81298b9cbac4760cd
MD5 b87e6c66a3c49d74e8f12e9405be51e4
BLAKE2b-256 b399109a8c5af9275446609dcd5a5f4e8128f616ca098a1fc3e70bff1b141db0

See more details on using hashes here.

Provenance

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