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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.3.17.1.tar.gz
  • Upload date:
  • Size: 101.2 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.17.1.tar.gz
Algorithm Hash digest
SHA256 2da6ef9eaffc2fcb60747bac49ef290d1e7710e94b37b436ab52ee97f1b6af80
MD5 fd8cbe603016f8fbe8dfd90242737888
BLAKE2b-256 fb352ab70859df1d21d33348d4f2d9de6cbd1fc7eca7e05875f87c1df5105922

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.17.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5188a1a575c46bbd028610889c2fa76731e0c29b89a9836e4755660173219d78
MD5 a1356bcf16111a4c700f4de3b23c5e86
BLAKE2b-256 a7ab0b28372ec2cbeb9b0ecdf07e259f3e91ebf19831cd5b2e08393533321400

See more details on using hashes here.

Provenance

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