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

Uploaded Source

Built Distribution

added_value-0.13.0-py2.py3-none-any.whl (24.4 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: added-value-0.13.0.tar.gz
  • Upload date:
  • Size: 17.6 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.13.0.tar.gz
Algorithm Hash digest
SHA256 133dd86bfbf5ebf4d81fba0634cc104171c39e68be614c0ab4b0fc8b91a5a5cb
MD5 acdf998b1f5b78b4fbb0c38f8ae275cd
BLAKE2b-256 1ddc475b5e9a205c55fc3f8e48d1be6f9694c6311fb99b7a1da472df153ca6a8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: added_value-0.13.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 24.4 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.13.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b8d57e14db77f7af004ab1d912d628fc6e4806e5cbbeb95650c5e41453427a6a
MD5 5cc58c1c3dd4ac3b6b4f01750229fc89
BLAKE2b-256 07f585fb9acb8b0716669a6fa41921665fc0f9945f9a1cfd3eac4e57f7d746a1

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