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.15.3.tar.gz (59.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.3.15.3-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.3.15.3.tar.gz
  • Upload date:
  • Size: 59.3 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.15.3.tar.gz
Algorithm Hash digest
SHA256 3dde160c8ddf119a169e115bbc658f26395796c24cea5633752919a855eb369f
MD5 09b84967c3ce5f035cca0084bf3b708f
BLAKE2b-256 de46a1658721d8d847a48d16c30831b8f6e0326d1b6493bd4e5e739c8d965dbf

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.15.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e50a6be567b5bb681cdd939ad34d6da3c4a96332b6ce85359577eb55d0f258d1
MD5 dd07f1ca3c985d4ab48505d3acc1b2b8
BLAKE2b-256 85c7fca2adbd720269d5d938aeb549e92bf7e6f12a0b49a536ab4af5738e3737

See more details on using hashes here.

Provenance

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