Skip to main content

Sphinx extension for literalizer — convert JSON to native language literals

Project description

Build Status PyPI

sphinx-literalizer

sphinx-literalizer is a Sphinx extension for literalizer, which converts JSON 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 JSON file and renders its contents as a native Python literal in a code block.

Full documentation

See the full documentation for more information including how to contribute.

Project details


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.3.20.tar.gz (103.7 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.3.20-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_literalizer-2026.3.20.tar.gz
Algorithm Hash digest
SHA256 3136106ac7efdd1586a5682bfb9b9a285953569d0e9ebe1dc0cdfbb57ba011c4
MD5 7390bea317e2814d4ab8ad47929c7ddd
BLAKE2b-256 a06e7545cd6be07459a947a80b16c270349a6752a079fe4e432b5399582d5005

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.20-py3-none-any.whl
Algorithm Hash digest
SHA256 5ab80df7d43b2794a4c83a2fb2d444c55bfb05d53280fb14d703d834319a75e5
MD5 6727a208ae79ebcdb929a71ec18d37ae
BLAKE2b-256 aa5f2a68346e4e5713c9d41eaeb05109340d131d45d4ffda644eb94ce77d6591

See more details on using hashes here.

Provenance

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page