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
2 maintainers
Release files for added-value 0.20.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| added-value-0.20.0.tar.gz | 20.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| added_value-0.20.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 52.5 kB
Release files / added-value-0.20.0.tar.gz
| Download URL | added-value-0.20.0.tar.gz |
|---|---|
| Size | 20.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
329757c8cdf99ad9aca7fbbeb1335b008b45aaa6cd745e44f10819e3839def53
|
|
BLAKE2b-256 checksum How to use checksums |
14a0dd62993272708c32ffce415dd6e80466fcfcb07e80c4e78177461015df0b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / added_value-0.20.0-py2.py3-none-any.whl
| Download URL | added_value-0.20.0-py2.py3-none-any.whl |
|---|---|
| Size | 31.6 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
28b93bc7f76b277cca73f0bb2659b8bf81f8d6415b1cb7b5ea995c79a0870551
|
|
BLAKE2b-256 checksum How to use checksums |
96f8080b8c3d2edcffb76decc9ca4516b00fe57c9762d1f17ec59e01926880d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
