added-value 0.24.0
Sphinx extension for embedding values extracted from Python modules
License: BSD 3-clause
Keywords: sphinx documentation

===========
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://github.com/sixty-north/added-value/workflows/CI/badge.svg?branch=master
     :target: https://github.com/sixty-north/added-value/actions?workflow=CI
     :alt: CI Status

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


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


Usage
=====

*Added Value* provides a number of roles and directives for embedding Python values into your
documentation. For example, sing added value we can extract the value of *pi* from the Python
Standard Library ``math`` module, and embed it in a sentence, using the ``format`` role provided
by *Added Values*, like this:

::

    The ratio of the circumference to the diameter of a circle is :format:`math.pi, .3f` to three
    decimal places.

Which gives:

    The ratio of the circumference to the diameter of a circle is 3.142 to three
    decimal places.

Powerful tools
--------------

Added value is powerful, and allows lists, dictionaries, and even complex data structures such as
lists of lists of dictionaries to be rendered into tables in various ways. Consult the
`documentation <https://added-value.readthedocs.io/en/latest/>`_ for more details.


Copyright 2023 Sixty North AS

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
   disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
   disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
   derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.