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.14.1.tar.gz (57.5 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.14.1-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_literalizer-2026.3.14.1.tar.gz
  • Upload date:
  • Size: 57.5 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.14.1.tar.gz
Algorithm Hash digest
SHA256 fdc9bad3f4e2d2b4f0988fe3451d0c456786c7400cf47320b59bbbc0c0116065
MD5 fabd971d5c9fb5a85a49a3f2933cb5ff
BLAKE2b-256 e6f0c5129a2ed7fdcac023d390f722f710b5894d723277b661cfcad70aaad3d9

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_literalizer-2026.3.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6773f738292b9cfd73b5707f3101e0173cb0334179fb34f9cdc1fef274f6bfe6
MD5 efc61d169c8df0e92d7cff79658b8faf
BLAKE2b-256 5ba5e0d9ef8213412d0910352b6067c5dbb9fc6e6955fe39200d46dc595429d4

See more details on using hashes here.

Provenance

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