History

liu-sheng c2e1db7c1d Switch to oslo.reports The Guru Meditation Reports has graduated from oslo-incubator, Cinder should switch to use oslo.reports to keep the code base clean. NOTE: this should be merged after the requirements has been synchronized. Change-Id: Ic91a0c5eed09ecdec93e707e901f4bcc55980f72 Closes-Bug: 1469575		2015-07-02 09:58:33 +08:00
..
ext	Replace xrange() with six.moves.range()	2015-06-16 10:46:40 +02:00
source	Switch to oslo.reports	2015-07-02 09:58:33 +08:00
.gitignore	Initial fork out of Nova.	2012-05-03 10:48:26 -07:00
Makefile	Initial fork out of Nova.	2012-05-03 10:48:26 -07:00
README.rst	Complete the doc/README.rst instructions to build docs	2015-04-16 08:13:04 +00:00
find_autodoc_modules.sh	Fixes a small issue in find_autodoc_modules.sh	2015-01-23 14:38:44 +08:00
generate_autodoc_index.sh	Initial fork out of Nova.	2012-05-03 10:48:26 -07: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 cinder 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

Use tox

The easiest way to build the docs and avoid dealing with all dependencies is to let tox prepare a virtualenv and run the build_sphinx target inside the virtualenv:

% cd ..
% tox -e docs

The docs have been built

Check out the build directory to find them. Yay!