openstack/cinder

History

Zhiteng Huang 2e0d1f41ec Fix typo/misspelled words Fix type/misspelled words found by this handy tools: https://github.com/lyda/misspell-check Some 'typo's were intentional since they are part of function name, so they are left alone. Change-Id: I4badda869521659b541d018727a6f71f518e2ee0		2013-12-03 22:49:12 +08:00
..
ext	Use built-in print() instead of print statement	2013-09-18 08:44:28 -07:00
source	Fix typo/misspelled words	2013-12-03 22:49:12 +08: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!