added-value 0.20.0

Sphinx "added-value" extension

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