6c7e8d9a23
This change adds an rst file for every tempest module, with the 'automodule' macro. The root of the API documetation will be in the 'API and test cases' section on the main page. https://review.openstack.org/39427 Change-Id: I4065a24328dc85bb158b15bdfddb10ee0839916b
49 lines
932 B
ReStructuredText
49 lines
932 B
ReStructuredText
.. Tempest documentation master file, created by
|
|
sphinx-quickstart on Tue May 21 17:43:32 2013.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
=======================
|
|
Tempest Testing Project
|
|
=======================
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
overview
|
|
HACKING
|
|
|
|
------------
|
|
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/cli
|
|
field_guide/scenario
|
|
field_guide/stress
|
|
field_guide/thirdparty
|
|
field_guide/whitebox
|
|
|
|
------------------
|
|
API and test cases
|
|
------------------
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
api/modules
|
|
|
|
==================
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`search`
|