=================== STUPS Documentation

.. image:: https://readthedocs.org/projects/stups/badge/?version=latest :target: https://readthedocs.org/projects/stups/?badge=latest :alt: Documentation Status

The STUPS documentation is available on http://docs.stups.io/

Local Usage

First install the Sphinx_ documentation generator.

.. code-block:: bash

$ pip install sphinx sphinx_rtd_theme

Generate the STUPS HTML documentation locally:

.. code-block:: bash

$ make html

.. _Sphinx: http://sphinx-doc.org/