History

Tin Lam 07b1779605 [Doc] Update quick start guide to Mitaka release

Also, corrected casing in the usage of the project names.

Change-Id: I2077bd27f6f3b8ef84b91c81b08e9d6eba1f68fd
Closes-Bug: #1562086

2016-05-18 19:10:46 -05:00

ext

py3: use six.moves.range instead of xrange

2014-12-27 18:41:21 +08:00

source

[Doc] Update quick start guide to Mitaka release

2016-05-18 19:10:46 -05:00

.gitignore

Initialize from cinder

2013-08-08 10:34:06 -04:00

find_autodoc_modules.sh

docs

2013-09-17 10:57:47 +03:00

generate_autodoc_index.sh

modified docs

2013-09-17 12:21:17 +03:00

Makefile

docs

2013-09-17 10:57:47 +03:00

README.rst

docs

2013-09-17 10:57:47 +03: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 manila 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!