Metadata-Version: 2.4
Name: sphinx-literalizer
Version: 2026.3.26.2
Summary: Sphinx extension for literalizer — convert JSON to native language literals
Author-email: Adam Dangoor <adamdangoor@gmail.com>
License-Expression: MIT
Project-URL: Documentation, https://adamtheturtle.github.io/sphinx-literalizer/
Project-URL: Source, https://github.com/adamtheturtle/sphinx-literalizer
Keywords: extension,json,literal,literalizer,sphinx
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx :: Extension
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.12
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: beartype==0.22.9
Requires-Dist: docutils
Requires-Dist: literalizer==2026.3.26.2
Requires-Dist: sphinx>=7.0
Provides-Extra: dev
Requires-Dist: actionlint-py==1.7.11.24; extra == "dev"
Requires-Dist: check-manifest==0.51; extra == "dev"
Requires-Dist: deptry==0.25.1; extra == "dev"
Requires-Dist: doc8==2.0.0; extra == "dev"
Requires-Dist: doccmd==2026.3.2; extra == "dev"
Requires-Dist: furo==2025.12.19; extra == "dev"
Requires-Dist: interrogate==1.7.0; extra == "dev"
Requires-Dist: mypy==1.19.1; extra == "dev"
Requires-Dist: mypy-strict-kwargs==2026.1.12; extra == "dev"
Requires-Dist: prek==0.3.8; extra == "dev"
Requires-Dist: pydocstringformatter==0.7.5; extra == "dev"
Requires-Dist: pylint==4.0.5; extra == "dev"
Requires-Dist: pyproject-fmt==2.20.0; extra == "dev"
Requires-Dist: pyrefly==0.58.0; extra == "dev"
Requires-Dist: pyright==1.1.408; extra == "dev"
Requires-Dist: pyroma==5.0.1; extra == "dev"
Requires-Dist: pytest==9.0.2; extra == "dev"
Requires-Dist: pytest-cov==7.1.0; extra == "dev"
Requires-Dist: ruff==0.15.7; extra == "dev"
Requires-Dist: shellcheck-py==0.11.0.1; extra == "dev"
Requires-Dist: shfmt-py==3.12.0.2; extra == "dev"
Requires-Dist: sphinx==9.1.0; extra == "dev"
Requires-Dist: sphinx-copybutton==0.5.2; extra == "dev"
Requires-Dist: sphinx-lint==1.0.2; extra == "dev"
Requires-Dist: sphinx-pyproject==0.3.0; extra == "dev"
Requires-Dist: sphinx-substitution-extensions==2026.1.12; extra == "dev"
Requires-Dist: sphinxcontrib-spelling==8.0.2; extra == "dev"
Requires-Dist: ty==0.0.25; extra == "dev"
Requires-Dist: types-docutils==0.22.3.20260322; extra == "dev"
Requires-Dist: vulture==2.16; extra == "dev"
Requires-Dist: yamlfix==1.19.1; extra == "dev"
Requires-Dist: zizmor==1.23.1; extra == "dev"
Provides-Extra: release
Requires-Dist: check-wheel-contents==0.6.3; extra == "release"
Dynamic: license-file

|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.).

.. contents::
   :local:

Installation
------------

Requires Python |minimum-python-version|\+.

.. code-block:: sh

   pip install sphinx-literalizer


Usage
-----

Add to your Sphinx ``conf.py``:

.. code-block:: python

   extensions = [
       # ...
       "sphinx_literalizer",
   ]

Then use the ``literalizer`` directive in your ``.rst`` files:

.. code-block:: rst

   .. 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 <https://adamtheturtle.github.io/sphinx-literalizer/>`__
for more information including how to contribute.

.. _literalizer: https://github.com/adamtheturtle/literalizer

.. |Build Status| image:: https://github.com/adamtheturtle/sphinx-literalizer/actions/workflows/ci.yml/badge.svg?branch=main
   :target: https://github.com/adamtheturtle/sphinx-literalizer/actions
.. |PyPI| image:: https://badge.fury.io/py/sphinx-literalizer.svg
   :target: https://badge.fury.io/py/sphinx-literalizer
.. |minimum-python-version| replace:: 3.12
