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.26.2.tar.gz (109.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.26.2-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.3.26.2.tar.gz
  • Upload date:
  • Size: 109.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.26.2.tar.gz
Algorithm Hash digest
SHA256 052c149c8ba9e23981702a9f83a7111a0b32eab8808bad6cc3cf58b9d4e7b9b7
MD5 ad7c14e5191bf933f36767262c5914ca
BLAKE2b-256 cba8f4fc8dfd7631a91a45e8f5102d535d9d4ad1a114887344665a670d3b022c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.26.2-py3-none-any.whl
Algorithm Hash digest
SHA256 947aed6917460a76cc5915e89c8fcd821e9053210314a67afbe03d9b3992578b
MD5 27c1c0ae05cb0e97c2e6b155ea4a6bf0
BLAKE2b-256 26d26a923e695f89a8fc39688e0f98268b68d6b1fe7981a16d89cebed6dd9ae3

See more details on using hashes here.

Provenance

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