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

Uploaded Source

Built Distribution

added_value-0.14.2-py2.py3-none-any.whl (25.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: added-value-0.14.2.tar.gz
  • Upload date:
  • Size: 18.0 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.14.2.tar.gz
Algorithm Hash digest
SHA256 8c886aee74635cec15beb64c28a90ae664526f331c1a4941e4d6ab98af232028
MD5 b2cebba60d993a4496ef57633926bfbc
BLAKE2b-256 19f32f9128971fd1619408291457e9c126c7d06a2dd209477a6f2937438ad6b4

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: added_value-0.14.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 25.0 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.14.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b25fcb86f9bfad9a40adf4d344322690e312741556c7b75681bc948380a251e6
MD5 7059a5738552b54c7dacae02c89323ae
BLAKE2b-256 fc9b7d6c8aa7c6731f96fdd8e99226058fa6eef2da21834ee7bd9546ccd3194a

See more details on using hashes here.

Provenance

Supported by

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