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/* $ 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.12.0.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: added-value-0.12.0.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.12.0.tar.gz
Algorithm Hash digest
SHA256 cfa9d057f33463403ec1b311645a226a854fdaf3409d8871f68fb7c90c39024e
MD5 b5eaef47ca99281dbf5d871c2eece07a
BLAKE2b-256 7167036c18d04b95aa99b61ce3900b3d584626a42c3701984d62c2179e501b41

See more details on using hashes here.

File details

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

File metadata

  • Download URL: added_value-0.12.0-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.12.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2707121741738353e9998c10a4b43a1bdcb31db4a23ef1ec2b99a38a9c30ebed
MD5 0c5177e67fb5de339b824ced70b88d4f
BLAKE2b-256 53f8df691d21c2e2738e855c9aca505c22a157fdc2d23f9a544ba2ce150772c2

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