History

Yun Mao 7dad062dd6 Remove outdated cinder test doc

cinder doesn't run pylint test. This was a left over from the
fork in nova-volume.

Change-Id: Id096ec97b37a2019baf7a0b55bfd5bce4e71908f

2013-05-09 17:58:28 -04:00

ext

Fix PEP8 issues.

2012-08-28 23:28:48 +08:00

source

Remove outdated cinder test doc

2013-05-09 17:58:28 -04:00

.gitignore

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

find_autodoc_modules.sh

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

generate_autodoc_index.sh

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

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

The docs have been built

Check out the build directory to find them. Yay!