Sphinx "added-value" extension
Project description
A Sphinx extension for embedding Python object values into documentation as text, lists or tables.
This is achieved by adding new roles and directives which refer to Python objects which contain the values to be represented. The extension provides roles for embedded single and lists of values, and a sophisticated directive for rendering complex data structures like lists of dictionaries as tables.
Status
Build status:
Installation
The added-value package is available on the Python Package Index (PyPI):
The package supports Python 3 only. To install:
$ pip install added-value
Development
Maintenance
$ pip install -e .
Testing
$ pip install -e .[test] $ pytest --cov=source tests
Documentation
$ pip install -e .[docs] $ cd docs $ make html
Release
$ pip install -e .[deploy] $ bumpversion minor $ python setup.py sdist bdist_wheel $ twine upload --config-file <path>/sixty-north.pypirc dist/* $ git push origin
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file added-value-0.16.0.tar.gz
.
File metadata
- Download URL: added-value-0.16.0.tar.gz
- Upload date:
- Size: 19.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5776ecd6f5a8f8be8bf63ad0d59470b8d6f474483b571e491b5e411cd94c8e4f |
|
MD5 | ecff3db9e534804e2e59bc6e42dbc37e |
|
BLAKE2b-256 | 856801a7de8a25e3ce8aff27606d3cd67684286aa21cab11de19feb3b562d73b |
Provenance
File details
Details for the file added_value-0.16.0-py2.py3-none-any.whl
.
File metadata
- Download URL: added_value-0.16.0-py2.py3-none-any.whl
- Upload date:
- Size: 26.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7351eb41950a6d0ac9cb86f19eac73ca7676171de9cbabf97271d7ba351550da |
|
MD5 | b8f9c5ef493fe24daee8358b030f6576 |
|
BLAKE2b-256 | d30fef8626981bb28d97cbd831fc52423c58726ad38a160fb45dc51085e679cb |