Skip to main content

Sphinx extension to include JSON-files in the documentation.

Project description

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:

pip install --upgrade setuptools pip wheel

Development steps for code changes

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.

cd docs
make clean; make html

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

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

mrsphinxjson-0.1.1.tar.gz (26.3 kB view details)

Uploaded Source

Built Distribution

mrsphinxjson-0.1.1-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file mrsphinxjson-0.1.1.tar.gz.

File metadata

  • Download URL: mrsphinxjson-0.1.1.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.1

File hashes

Hashes for mrsphinxjson-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f4d78fe6689d351d00deb05239cb50900887ab835770d5aa641782a93e469a4a
MD5 8fbdfd9eea03a19ee80d570e8bae07b0
BLAKE2b-256 b693bd035d400cfea6ffaa0caf1ae10f11093aa207ad8d1d9d255de8542f010f

See more details on using hashes here.

File details

Details for the file mrsphinxjson-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: mrsphinxjson-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.1

File hashes

Hashes for mrsphinxjson-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 602decf0250fbe55120c23242a1d589e54256b7ab1c0ef9caecb29f3f332a937
MD5 40d297b1ce87a29e2a638c951195a0f2
BLAKE2b-256 3370828428f93940632abdcb17b7bcf32658d393acf540b6ceebe0457c89b81c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page