Skip to main content

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.


Build status: Documentation Status


The added-value package is available on the Python Package Index (PyPI):

The package supports Python 3 only. To install:

$ pip install added-value



$ pip install -e .


$ pip install -e .[test]
$ pytest --cov=source tests


$ pip install -e .[docs]
$ cd docs
$ make html


$ pip install -e .[deploy]
$ bumpversion minor
$ python sdist bdist_wheel
$ twine upload --config-file <path>/sixty-north.pypirc dist/*
$ git push origin

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for added-value, version 0.15.0
Filename, size File type Python version Upload date Hashes
Filename, size added_value-0.15.0-py2.py3-none-any.whl (26.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size added-value-0.15.0.tar.gz (19.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page