diff options
| author | Matthew Treinish <mtreinish@kortar.org> | 2015-02-11 18:17:58 -0500 |
|---|---|---|
| committer | Matthew Treinish <mtreinish@kortar.org> | 2015-02-11 19:04:47 -0500 |
| commit | 292989688a2281f5f8dc6d5b8fb216ba712ea80d (patch) | |
| tree | b5c6af3eae5b5e834ccce044a32ad6a287d33eb4 /doc/source/usage.rst | |
| parent | 21e3f6a29a368840b66fe6fccd60abd431bbc727 (diff) | |
| download | tempest-lib-292989688a2281f5f8dc6d5b8fb216ba712ea80d.tar.gz | |
Improve the library's documentation
This commit is the first step in improving the library's documentation.
It adds missing details to a lot of the default cookiecutter docs which
have mostly sat untouched since the repo was created. The release notes
are also brought up to date and adds autodoc pages for all the modules
with public functions.
Change-Id: Id249c95fb269d07628952a4182675bce1fc18a53
Diffstat (limited to 'doc/source/usage.rst')
| -rw-r--r-- | doc/source/usage.rst | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 4aeb40f..e305244 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -4,4 +4,21 @@ Usage To use tempest-lib in a project:: - import tempest_lib
\ No newline at end of file + import tempest_lib + +:ref:`cli` +---------- +The CLI testing framework allows you to test the command line interface for +an OpenStack project's python-*client + + +:ref:`decorators` +----------------- +These decorators enable common utility functions inside of your test suite + + +:ref:`rest_client` +------------------ +The base building block for making a project specific client + + |