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.1.tar.gz (104.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.22.1-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.3.22.1.tar.gz
  • Upload date:
  • Size: 104.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.22.1.tar.gz
Algorithm Hash digest
SHA256 a9a3b6162b616c5e5f2b01aad308851104e84ce08ea4a70f4d6e9df5f2f336d4
MD5 01aa30136e20aea436b42d1b803562d5
BLAKE2b-256 4f765037f1a078d63fcbc6503c694ba78f8eed1601366cf53d22cae6470d7adb

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.22.1-py3-none-any.whl
Algorithm Hash digest
SHA256 129be1eea14e92eced30591c28571063f5045ffb8467b777e63cde0c9e176928
MD5 86ec96154f8ecc2df9adbeecc59b6886
BLAKE2b-256 76bc350a64bb60208c37a2fe14b11cb6cfa45ace9955c2891c86bbba89e74e27

See more details on using hashes here.

Provenance

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