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.

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/*

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.9.1.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

added_value-0.9.1-py2.py3-none-any.whl (20.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file added-value-0.9.1.tar.gz.

File metadata

  • Download URL: added-value-0.9.1.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for added-value-0.9.1.tar.gz
Algorithm Hash digest
SHA256 19e5bfaf918ed99ede3353ef9467d95fbbf90c250a016e17a38d7333ed38abbd
MD5 bd2add226ec0a33d446deec7980b2182
BLAKE2b-256 403aa465aecc9d07c9b09ebe66373931c1ceeae34f8ea9f95a8b7a52382cac15

See more details on using hashes here.

File details

Details for the file added_value-0.9.1-py2.py3-none-any.whl.

File metadata

  • Download URL: added_value-0.9.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 20.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using 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

File hashes

Hashes for added_value-0.9.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6835207cd8a9be4bb1ccc04c747c934d5ba83a14a23b08ce0f8380907bc36d37
MD5 5cb2a6dc6f9448646cf4ee503cebec1f
BLAKE2b-256 b01f5f90c849c2cabd27a87eb483f18f907020ae9ed2909c96bda24fb8167233

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page