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.22.tar.gz (106.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.22-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.3.22.tar.gz
  • Upload date:
  • Size: 106.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.22.tar.gz
Algorithm Hash digest
SHA256 c893f8aa7b7705b663fbde5689c2298485976cb4b9036c0b64177d599154ce4b
MD5 cb6bbe9698d59bb013170a47ef1b3dea
BLAKE2b-256 c86a4677a18699c6a12b1b191c9f3a40c3620f3d703b4e1fbda8677c9d912f88

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.22-py3-none-any.whl
Algorithm Hash digest
SHA256 4bc2d6d65ba357c8081945f500d1543521efec87b3ad4f67ffc916e22ee2617e
MD5 44091cf4e1bbbee702d618fb7b534c52
BLAKE2b-256 9eab7d4c91502456189a398f1c84769cfda97169430cbcae53b9f1fc0aa461b0

See more details on using hashes here.

Provenance

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