f2dc050e4d
This commit integrates functionality from the `openstack.common.report` module into Cinder. This enables Cinder services to receive SIGUSR1 and print a Guru Meditation Report to stderr. The required modules were added to 'openstack-common.conf' as well. It is essentially a copy from implementation of nova side. Change-Id: I5bbdc0f97db9b0ebd7b48e50ab7869e2ca33aead Implements: blueprint guru-meditation-report
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!