5dfbef4f95
This reverts commit 466a19f18f12cb77b45aa7c7a272fae7c45c4c93. Also this reverts commit 4f74b224fad7bf9ca665d70a66c79c98cf8d5674. Manila has decided to remove LXD from the Mitaka release. http://lists.openstack.org/pipermail/openstack-dev/2016-March/089522.html Change-Id: I3c4b15e8c9d92c874be754205b0b981151809cc1
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!