57d6c5d1bc
Cinder docs were not building because sphinx was looking for cinder-manage.rst which did not exist. The file was simply misnamed and renaming it to cinder-manage.rst allows the docs to build. Change-Id: I68f4ed81230cc277a96bb34dfa172e5ce7788ac4
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
The docs have been built
Check out the build directory to find them. Yay!