openstack/cinder

History

git-harry 0106c02057 Update prerequisite packages in development docs The packages listed for Linux distros are updated to meet the prerequisites to run the unit tests. Change-Id: Iedd9e4d04d7700d418ddb07881ac76ad758466cb Closes-bug: #1367670		2014-11-19 23:09:36 +00:00
..
ext	Remove definition of Python Source Code Encodings	2014-07-10 17:33:01 +09:00
source	Update prerequisite packages in development docs	2014-11-19 23:09:36 +00: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!