ea7a9820fd
Doesn't do much good to add a doc if you never add it to the index and remove spurious headers that cause it to not publish. This patch fixes those problems. Change-Id: I5c1906a30539e7223f5cee8ce14a013005fe004d
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
dotlanguage from Graphviz.sudo apt-get install graphviz
Use make
Just type make:
% makeLook 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.rstRun `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 docsThe docs have been built
Check out the build directory to find them. Yay!