a68156c100
Resolves unclear formatting of compute extensions documentation at http://nova.openstack.org/api_ext/index.html The rst extensions template has been updated to include extension name as top level hierarchy, and demote all other content. All existing documentation pages have been reformatted as per the updated template. The ext_aggreagates.rst file has also been added to index.rst. Amendments: - Author added to Authors file - Typo in ext_volumes.rst fixed Change-Id: Id67ef91a6e8eaaf4fba46abbd57759c77aaf8991
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 nova 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!