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.26.1.tar.gz (109.6 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.26.1-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.3.26.1.tar.gz
  • Upload date:
  • Size: 109.6 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.26.1.tar.gz
Algorithm Hash digest
SHA256 ed693510a594dea596d2659323c7af7c80a44d041fa69bb87b8ddfd87b7851f0
MD5 37b6c8156fa128f0ce3b296f80701235
BLAKE2b-256 866bcbb3265d747bfcbd6ed2ba86ca0af39359fd7bd18adec24e5905c4683270

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.26.1-py3-none-any.whl
Algorithm Hash digest
SHA256 92f3346dfbb29768b90c37b414ebfb20634c8c3404be0a3188c7870b2c9fe7c7
MD5 1960defcd35387bcd7692de8d057695d
BLAKE2b-256 57533bd8454efb74c0ced302166c6976e9680376dee8019d55929f0208493ade

See more details on using hashes here.

Provenance

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

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