History

Valeriy Ponomaryov 797bbcb303 [Tempest] Add valuable tags to tests To be able to run tests based on following criteria: - Only API is required and tested. - API and share back-end required, API is tested. - API and share back-end required, back-end is tested Also, add doc with detailed description of running subset of tests. Change-Id: I9ae105eaa527621c85d5038bba15edf4b065eaa3 Closes-Bug: #1587874		2016-06-08 11:25:32 +03:00
..
ext	py3: use six.moves.range instead of xrange	2014-12-27 18:41:21 +08:00
source	[Tempest] Add valuable tags to tests	2016-06-08 11:25:32 +03:00
.gitignore	Initialize from cinder	2013-08-08 10:34:06 -04:00
Makefile	docs	2013-09-17 10:57:47 +03:00
README.rst	docs	2013-09-17 10:57:47 +03:00
find_autodoc_modules.sh	docs	2013-09-17 10:57:47 +03:00
generate_autodoc_index.sh	modified docs	2013-09-17 12:21:17 +03:00

README.rst

Building the docs

Dependencies

Sphinx

You'll need sphinx (the python one) and if you are using the virtualenv you'll need to install it in the virtualenv specifically so that it can load the manila modules.

pip install Sphinx

Graphviz

Some of the diagrams are generated using the dot language from Graphviz.

sudo apt-get install graphviz

Use make

Just type make:

% make

Look in the Makefile for more targets.

Manually

Generate the code.rst file so that Sphinx will pull in our docstrings:
% ./generate_autodoc_index.sh > source/code.rst
Run `sphinx_build`:
% sphinx-build -b html source build/html

The docs have been built

Check out the build directory to find them. Yay!