blob: f70cdd10de527a7d762adbe19961bd2e65af97b2 [file] [log] [blame]
Sean Dagueb56052b2013-05-21 17:57:41 -04001.. Tempest documentation master file, created by
2 sphinx-quickstart on Tue May 21 17:43:32 2013.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
Attila Fazekas23fdf1d2013-06-09 16:35:23 +02006=======================
Sean Dagueb56052b2013-05-21 17:57:41 -04007Tempest Testing Project
Attila Fazekas23fdf1d2013-06-09 16:35:23 +02008=======================
Sean Dagueb56052b2013-05-21 17:57:41 -04009
10Contents:
11
12.. toctree::
13 :maxdepth: 2
14
15 overview
Attila Fazekas23fdf1d2013-06-09 16:35:23 +020016 HACKING
Sean Dagueb56052b2013-05-21 17:57:41 -040017
Attila Fazekas23fdf1d2013-06-09 16:35:23 +020018------------
Sean Dague7679b482013-05-24 08:49:44 -040019Field Guides
Attila Fazekas23fdf1d2013-06-09 16:35:23 +020020------------
Sean Dague7679b482013-05-24 08:49:44 -040021Tempest contains tests of many different types, the field guides
22attempt to explain these in a way that makes it easy to understand
23where your test contributions should go.
Sean Dagueb56052b2013-05-21 17:57:41 -040024
25.. toctree::
Sean Dague7679b482013-05-24 08:49:44 -040026 :maxdepth: 1
Sean Dagueb56052b2013-05-21 17:57:41 -040027
28 field_guide/index
29 field_guide/api
30 field_guide/cli
31 field_guide/scenario
32 field_guide/stress
33 field_guide/thirdparty
34 field_guide/whitebox
Matthew Treinish32d35702013-08-13 11:59:06 -040035 field_guide/unit_tests
Sean Dagueb56052b2013-05-21 17:57:41 -040036
Attila Fazekas6c7e8d92013-07-30 15:59:49 +020037------------------
38API and test cases
39------------------
40.. toctree::
41 :maxdepth: 1
42
43 api/modules
Sean Dagueb56052b2013-05-21 17:57:41 -040044
Sean Dague7679b482013-05-24 08:49:44 -040045==================
Sean Dagueb56052b2013-05-21 17:57:41 -040046Indices and tables
47==================
48
Sean Dagueb56052b2013-05-21 17:57:41 -040049* :ref:`search`