Metadata-Version: 2.1
Name: mrsphinxjson
Version: 0.1.1
Summary: Sphinx extension to include JSON-files in the documentation.
Home-page: https://gitlab.com/anatas_ch/pyl_mrsphinxjson
Author: Michael Rippstein
Author-email: info@anatas.ch
License: AGPL-3.0
Project-URL: Bug Tracker, https://gitlab.com/anatas_ch/pyl_mrsphinxjson/-/issues
Project-URL: Source Code, https://gitlab.com/anatas_ch/pyl_mrsphinxjson
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE

mrsphinxjson - Sphinx extension to include JSON-files in the documentation.
===========================================================================

Sphinx extension to include JSON-files in the documentation.

Usage
-----



License
-------

GNU AFFERO GENERAL PUBLIC LICENSE Version 3


Developer guide
---------------

Upgrade your setup tools and pip.
They are needed for development and testing only:

.. code:: bash

   pip install --upgrade setuptools pip wheel

Development steps for code changes

.. code:: bash

   git clone https://gitlab.com/anatas_ch/pyl_mrsphinxjson.git
   cd pyl_sphinxcontrib-json
   git switch develop
   pip install -r requirements_rnd.txt
   pip install -e .

`docs` folder contains the package documentantion.

.. code:: bash

   cd docs
   make clean; make html

Once you have finished your changes, please provide test case(s) and relevant documentation.


