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.4.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.4-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.3.15.4.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.4.tar.gz
Algorithm Hash digest
SHA256 e5e51ad74b0da1454c70df75370f1775052655bb13bbb3fc229e71756d48d84f
MD5 3baa341cf82b13e62bdb60faf1e535b3
BLAKE2b-256 2b09dc9aa408b8924df681f15d4709e3414a5b168e7d6f4b146c2584c2c4d198

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.15.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6cb2f618e41e945351ef5c410443441f2db1baf864b560ce14ee9e40237601f6
MD5 77ace295abc149b2cfb7f1ad762df026
BLAKE2b-256 1d0fd200fcc611dcfdde98c0e2547b65c1111c9a36067b4f687ece8d1351d9d2

See more details on using hashes here.

Provenance

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