History

John Griffith 9906ea1ed7 Add basic workflow of attach/detach to devref

This is something that confuses folks and isn't centrally
located.  So... add it to the devref docs and hope that
developers read it.

There's tons of detail we can add in the future of course,
but this at least clears up some of the common misconceptions
that exist currently.

Change-Id: Ic5fb8da06d18fac3369a91a525accc75c1d28100

2016-02-26 21:24:29 +00:00

ext

Replace xrange() with six.moves.range()

2015-06-16 10:46:40 +02:00

source

Add basic workflow of attach/detach to devref

2016-02-26 21:24:29 +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

Complete the doc/README.rst instructions to build docs

2015-04-16 08:13:04 +00: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!