Metadata-Version: 2.1
Name: added-value
Version: 0.14.2
Summary: Sphinx "added-value" extension
Home-page: https://github.com/sixty-north/added-value
Author: Robert Smallshire
Author-email: rob@sixty-north.com
License: BSD
Download-URL: https://pypi.python.org/pypi/added-value
Project-URL: Source, https://github.com/sixty-north/added-value
Project-URL: Documentation, https://added-value.readthedocs.io/en/latest/
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires: docutils
Requires: sphinx
Requires: natsort
Requires: six
Provides-Extra: test
Provides-Extra: deploy
Provides-Extra: docs
Requires-Dist: docutils
Requires-Dist: sphinx
Requires-Dist: natsort
Requires-Dist: six
Provides-Extra: deploy
Requires-Dist: bumpversion; extra == 'deploy'
Requires-Dist: twine; extra == 'deploy'
Requires-Dist: wheel; extra == 'deploy'
Provides-Extra: docs
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: coveralls; extra == 'test'
Requires-Dist: beautifulsoup4; extra == 'test'
Requires-Dist: hypothesis; extra == 'test'

===========
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:

.. image:: https://travis-ci.org/sixty-north/added-value.svg?branch=master
    :target: https://travis-ci.org/sixty-north/added-value

.. image:: https://readthedocs.org/projects/added-value/badge/?version=latest
    :target: https://added-value.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://coveralls.io/repos/github/sixty-north/added-value/badge.svg?branch=master
    :target: https://coveralls.io/github/sixty-north/added-value?branch=master



Installation
============

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

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

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


