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.19.tar.gz (101.8 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.19-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.3.19.tar.gz
  • Upload date:
  • Size: 101.8 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.19.tar.gz
Algorithm Hash digest
SHA256 1bd02989df30cdffa216d24e2447683b565cba6191cdfff3c590825ad646d4a7
MD5 1b3dec07f2e1b49573a7c2706be486e4
BLAKE2b-256 7f8052d3f453543e910c45371785519340a8a8e69364c26690429f82fa0aff5c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.19-py3-none-any.whl
Algorithm Hash digest
SHA256 08e434369ea4a19aa9ea38b511063199f0637d7bf0f56705fe431973a9155f0c
MD5 34a13c978c3d5acf7b61172b6b74f5c7
BLAKE2b-256 dc1193931274d046e76506e88ddee78b0576b94fecabd2b02988a492d12c4078

See more details on using hashes here.

Provenance

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