blob: f5628507dec1c57ddf14fe304e2ad94f6c8b9e70 [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 +09005Overview
Masayuki Igawad2a657d2017-05-08 15:25:56 -04006========
Sean Dagueb56052b2013-05-21 17:57:41 -04007
8.. toctree::
9 :maxdepth: 2
10
11 overview
12
Sean Dague7679b482013-05-24 08:49:44 -040013Field Guides
Masayuki Igawad2a657d2017-05-08 15:25:56 -040014============
Sean Dague7679b482013-05-24 08:49:44 -040015Tempest contains tests of many different types, the field guides
16attempt to explain these in a way that makes it easy to understand
17where your test contributions should go.
Sean Dagueb56052b2013-05-21 17:57:41 -040018
19.. toctree::
Sean Dague7679b482013-05-24 08:49:44 -040020 :maxdepth: 1
Sean Dagueb56052b2013-05-21 17:57:41 -040021
22 field_guide/index
23 field_guide/api
Sean Dagueb56052b2013-05-21 17:57:41 -040024 field_guide/scenario
Matthew Treinish32d35702013-08-13 11:59:06 -040025 field_guide/unit_tests
Sean Dagueb56052b2013-05-21 17:57:41 -040026
Masayuki Igawae88caa82017-05-22 17:53:15 +090027Users Guide
28===========
Masayuki Igawad787bc22016-06-29 14:30:24 +090029
Matthew Treinishbc1b15b2015-02-20 15:56:07 -050030Tempest Configuration Guide
31---------------------------
32
33.. toctree::
34 :maxdepth: 2
35
36 configuration
Mathew Oddenb389faa2015-07-30 20:24:08 +000037 sampleconf
Matthew Treinishbc1b15b2015-02-20 15:56:07 -050038
David Patersonce781492014-09-18 01:07:01 -040039Command Documentation
40---------------------
41
42.. toctree::
43 :maxdepth: 1
44
Jane Zadorozhna00fc3dc2015-05-27 18:01:56 +030045 account_generator
David Patersonce781492014-09-18 01:07:01 -040046 cleanup
Stephen Lowriec8548fc2016-05-24 15:57:35 -050047 subunit_describe_calls
step682980c14ec2016-02-23 14:53:52 -050048 workspace
Matthew Treinisha051c222016-05-23 15:48:22 -040049 run
David Patersonce781492014-09-18 01:07:01 -040050
Masayuki Igawae88caa82017-05-22 17:53:15 +090051Developers Guide
52================
Masayuki Igawad787bc22016-06-29 14:30:24 +090053
Masayuki Igawad787bc22016-06-29 14:30:24 +090054Development
55-----------
56
57.. toctree::
58 :maxdepth: 2
59
60 HACKING
61 REVIEWING
62 microversion_testing
Ken'ichi Ohmichid8386a32017-03-31 10:56:58 -070063 test_removal
Matthew Treinishe8ab5f92017-03-01 15:25:39 -050064 write_tests
Masayuki Igawad787bc22016-06-29 14:30:24 +090065
Masayuki Igawad787bc22016-06-29 14:30:24 +090066Plugins
67-------
68
69.. toctree::
70 :maxdepth: 2
71
72 plugin
73 plugin-registry
74
Masayuki Igawad787bc22016-06-29 14:30:24 +090075Library
76-------
77
78.. toctree::
79 :maxdepth: 2
80
81 library
82
Sean Dagueb56052b2013-05-21 17:57:41 -040083Indices and tables
84==================
85
Sean Dagueb56052b2013-05-21 17:57:41 -040086* :ref:`search`