openstack/manila

History

vponomaryov 08612d7524 Update manila's docs After manila's fork from cinder, its docs were not updated well. This info is used by doc-builder, see doc/README.rst Partially implements: blueprint manila-documentation Change-Id: Ic97584db291b60505d5d310a517c2866fc6fcf5f		2014-06-23 19:19:28 +03:00
..
ext	Update manila's docs	2014-06-23 19:19:28 +03:00
source	Update manila's docs	2014-06-23 19:19:28 +03: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!