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.1.tar.gz (58.1 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.1-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.3.15.1.tar.gz
  • Upload date:
  • Size: 58.1 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.1.tar.gz
Algorithm Hash digest
SHA256 d1261b69a9d85ccec50936bd7de73f5be93d790ac2bc8cd32124815a74ab254e
MD5 d1ce78d499dae33c10e56a405a268409
BLAKE2b-256 23ab320d9acd3f3eec915d5203a88ee7e789730bc6776fcc8b638c3bacf500ec

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2bcdc220ede9476ed14f1f23e960311f6816293740f0403b60cc4b811b51614a
MD5 9924b20669cc5db2c6951d124784b985
BLAKE2b-256 e2e501463f9ed2d2d52ac30db5477379d18a60cf981a493413f0e4dafa984600

See more details on using hashes here.

Provenance

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