Skip to main content

Added Value

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:

https://travis-ci.org/sixty-north/added-value.svg?branch=master Documentation Status https://coveralls.io/repos/github/sixty-north/added-value/badge.svg?branch=master

Installation

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

https://badge.fury.io/py/added-value.svg

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

Metadata

Release files for added-value 0.14.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for added-value 0.14.0
File Size Uploaded
added-value-0.14.0.tar.gz 17.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for added-value 0.14.0
File Interpreter ABI Platform
added_value-0.14.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 42.6 kB

Release files / added-value-0.14.0.tar.gz

Download URL added-value-0.14.0.tar.gz
Size 17.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0058895d3f2af7dae58c73ea963f2a55aa5d111194a3d5f223d707816e2d47be
BLAKE2b-256 checksum
How to use checksums
c741fb35b9c0b59ace9c9ffcb10eadd5576db8a192e25cf860064f1a55cd2116
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.14.0-py2.py3-none-any.whl

Download URL added_value-0.14.0-py2.py3-none-any.whl
Size 24.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
de43cd26dc059f01f6c52e3e7a14624f7a58ce0a20c603e8d1bcdc95e9673d4a
BLAKE2b-256 checksum
How to use checksums
91400b5988a108b89d47a9555d70f9697ae76fa3d974092a810fe94bc4e50936
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 history Release notifications | RSS feed

0.24.0

2 release files

0.23.0

2 release files

0.22.2

2 release files

0.21.5

2 release files

0.20.0

2 release files

0.18.0

2 release files

0.17.0

2 release files

0.16.0

2 release files

0.14.1

2 release files

This release

0.14.0 This release

2 release files

0.13.0

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8

2 release files

0.7

2 release files

0.6

2 release files

0.5

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page