Skip to content

Commit

Permalink
fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
hjacobs committed Apr 8, 2015
1 parent 9f80625 commit 16738d0
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,23 @@
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://stups.readthedocs.org/

Local Usage
===========

First install the Sphinx_ documentation generator.

.. code-block:: bash
$ pip install sphinx sphinx_rtd_theme
Generate the Pequod HTML documentation locally:
Generate the STUPS HTML documentation locally:

.. code-block:: bash
Expand Down

0 comments on commit 16738d0

Please sign in to comment.