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.2.tar.gz (59.2 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.2-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.3.15.2.tar.gz
  • Upload date:
  • Size: 59.2 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.2.tar.gz
Algorithm Hash digest
SHA256 187e85a5b930941e850fe30b18c87a35d5f9fb9ad6690347849f122477a61cdc
MD5 aa8edd08089e59e44154dc635bdad25f
BLAKE2b-256 31e1226e380635735a49a648b8be925d250b7c35bf6105c62a4213e049ec4c4f

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.15.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fac130b5296f3fc06d56b787471200889733a91bab68fba46516a3728958aea2
MD5 8fc8e48e9480365dd4ff63b389b9e356
BLAKE2b-256 4ecea86a022e12914904696cc70383327c5335b988dce24eb2695c33026e7d93

See more details on using hashes here.

Provenance

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