tempest/doc/source/index.rst
Matthew Treinish f45ba2e604
Cleanup tempest docs a bit
This commit fixes a few things in the tempest docs. First it fixes all
of the sphinx warnings and enables fail on warn to ensure we're using
valid sphinx everywhere. It also adds a link from the configuration
guide to the sample config file.

Change-Id: I3ad645a6bbfa46b4498e1732410743e46d6eb0cb
2015-09-02 11:06:44 -04:00

58 lines
905 B
ReStructuredText

=======================
Tempest Testing Project
=======================
Contents:
.. toctree::
:maxdepth: 2
overview
HACKING
REVIEWING
plugin
------------
Field Guides
------------
Tempest contains tests of many different types, the field guides
attempt to explain these in a way that makes it easy to understand
where your test contributions should go.
.. toctree::
:maxdepth: 1
field_guide/index
field_guide/api
field_guide/scenario
field_guide/stress
field_guide/thirdparty
field_guide/unit_tests
---------------------------
Tempest Configuration Guide
---------------------------
.. toctree::
:maxdepth: 2
configuration
sampleconf
---------------------
Command Documentation
---------------------
.. toctree::
:maxdepth: 1
account_generator
cleanup
javelin
==================
Indices and tables
==================
* :ref:`search`