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.

Source Distribution

added-value-0.16.0.tar.gz (19.2 kB view hashes)

Uploaded Source

Built Distribution

added_value-0.16.0-py2.py3-none-any.whl (26.8 kB view hashes)

Uploaded Python 2 Python 3

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