History

liyingjun 05a6ad4b4f Fixes a small issue in find_autodoc_modules.sh

When generating docs, the modules listed under api all seem to be
missing the first letter after "cinder." at the beginning.

Change-Id: I924e55642350d3bb813ebab7cb978915fdd8b964
Closes-bug: #1408828

2015-01-23 14:38:44 +08:00

ext

Remove definition of Python Source Code Encodings

2014-07-10 17:33:01 +09:00

source

Workflow documentation is now in infra-manual

2014-12-05 04:39:45 +00:00

.gitignore

Initial fork out of Nova.

2012-05-03 10:48:26 -07: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

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!