.. MetricQ documentation master file, created by
   sphinx-quickstart on Sat May  2 17:18:05 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to MetricQ's documentation!
===================================

.. toctree::
    :maxdepth: 3
    :caption: Contents:

    howto/index
    api/index
    metadata
    upgrading
    glossary


Quickstart
----------


Installation
^^^^^^^^^^^^

Install ``metricq`` from `PyPI`_:

.. code-block:: shell

    $ pip install metricq

..  _PyPI: https://pypi.org/project/metricq/


Upgrading from an older version
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

See :ref:`upgrading` for instruction on how to upgrade to a newer version of this library.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`glossary`