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.16.1.tar.gz (59.6 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.16.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.3.16.1.tar.gz
  • Upload date:
  • Size: 59.6 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.16.1.tar.gz
Algorithm Hash digest
SHA256 b3f2dc9c083502260d287ab231447a5ad666b045eba7cbcc83510df23fb31817
MD5 2204e7e007d0a2d55515a1f68be24a38
BLAKE2b-256 881bad4ced3b121bc79728540904c7486dbb020d98dc12fd5d0913591eb8b0a1

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.16.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cf53d8018e8e2494e08faceb7acb47f443ea94415f6aa73a35011bcd2f0af88e
MD5 391a6aaed19ec474e2034bca651c04ec
BLAKE2b-256 c7b3607f7124e099662eb116055b46a1f19a46b790781b219ad46e2e3e9c450f

See more details on using hashes here.

Provenance

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