openstack
/
manila
Code Issues Proposed changes
manila/doc
History
Alexey Ovchinnikov 5dfbef4f95 Revert "LXC/LXD driver" 
This reverts commit 466a19f18f.
Also this reverts commit 4f74b224fa.

Manila has decided to remove LXD from the Mitaka release.
http://lists.openstack.org/pipermail/openstack-dev/2016-March/089522.html

Change-Id: I3c4b15e8c9d92c874be754205b0b981151809cc1
 		2016-03-16 18:48:17 +04:00
..
ext py3: use six.moves.range instead of xrange 2014-12-27 18:41:21 +08:00
source Revert "LXC/LXD driver" 2016-03-16 18:48:17 +04:00
.gitignore Initialize from cinder 2013-08-08 10:34:06 -04:00
Makefile docs 2013-09-17 10:57:47 +03:00
README.rst docs 2013-09-17 10:57:47 +03: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

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

  1. Generate the code.rst file so that Sphinx will pull in our docstrings:

    % ./generate_autodoc_index.sh > source/code.rst

  2. Run `sphinx_build`:

    % sphinx-build -b html source build/html

The docs have been built

Check out the build directory to find them. Yay!