blob: 1264eccc957b2effd769e4606afa86a362a1f40b [file] [log] [blame]
Attila Fazekas23fdf1d2013-06-09 16:35:23 +02001=======================
Sean Dagueb56052b2013-05-21 17:57:41 -04002Tempest Testing Project
Attila Fazekas23fdf1d2013-06-09 16:35:23 +02003=======================
Sean Dagueb56052b2013-05-21 17:57:41 -04004
Masayuki Igawad787bc22016-06-29 14:30:24 +09005--------
6Overview
7--------
Sean Dagueb56052b2013-05-21 17:57:41 -04008
9.. toctree::
10 :maxdepth: 2
11
12 overview
13
Attila Fazekas23fdf1d2013-06-09 16:35:23 +020014------------
Sean Dague7679b482013-05-24 08:49:44 -040015Field Guides
Attila Fazekas23fdf1d2013-06-09 16:35:23 +020016------------
Sean Dague7679b482013-05-24 08:49:44 -040017Tempest contains tests of many different types, the field guides
18attempt to explain these in a way that makes it easy to understand
19where your test contributions should go.
Sean Dagueb56052b2013-05-21 17:57:41 -040020
21.. toctree::
Sean Dague7679b482013-05-24 08:49:44 -040022 :maxdepth: 1
Sean Dagueb56052b2013-05-21 17:57:41 -040023
24 field_guide/index
25 field_guide/api
Sean Dagueb56052b2013-05-21 17:57:41 -040026 field_guide/scenario
Matthew Treinish32d35702013-08-13 11:59:06 -040027 field_guide/unit_tests
Sean Dagueb56052b2013-05-21 17:57:41 -040028
Masayuki Igawad787bc22016-06-29 14:30:24 +090029=========
30For users
31=========
32
Matthew Treinishbc1b15b2015-02-20 15:56:07 -050033---------------------------
34Tempest Configuration Guide
35---------------------------
36
37.. toctree::
38 :maxdepth: 2
39
40 configuration
Mathew Oddenb389faa2015-07-30 20:24:08 +000041 sampleconf
Matthew Treinishbc1b15b2015-02-20 15:56:07 -050042
David Patersonce781492014-09-18 01:07:01 -040043---------------------
44Command Documentation
45---------------------
46
47.. toctree::
48 :maxdepth: 1
49
Jane Zadorozhna00fc3dc2015-05-27 18:01:56 +030050 account_generator
David Patersonce781492014-09-18 01:07:01 -040051 cleanup
Stephen Lowriec8548fc2016-05-24 15:57:35 -050052 subunit_describe_calls
step682980c14ec2016-02-23 14:53:52 -050053 workspace
Matthew Treinisha051c222016-05-23 15:48:22 -040054 run
David Patersonce781492014-09-18 01:07:01 -040055
Masayuki Igawad787bc22016-06-29 14:30:24 +090056==============
57For developers
58==============
59
60-----------
61Development
62-----------
63
64.. toctree::
65 :maxdepth: 2
66
67 HACKING
68 REVIEWING
69 microversion_testing
Ken'ichi Ohmichid8386a32017-03-31 10:56:58 -070070 test_removal
Matthew Treinishe8ab5f92017-03-01 15:25:39 -050071 write_tests
Masayuki Igawad787bc22016-06-29 14:30:24 +090072
73-------
74Plugins
75-------
76
77.. toctree::
78 :maxdepth: 2
79
80 plugin
81 plugin-registry
82
83-------
84Library
85-------
86
87.. toctree::
88 :maxdepth: 2
89
90 library
91
Sean Dague7679b482013-05-24 08:49:44 -040092==================
Sean Dagueb56052b2013-05-21 17:57:41 -040093Indices and tables
94==================
95
Sean Dagueb56052b2013-05-21 17:57:41 -040096* :ref:`search`