15bd189235
Unlike other cinder-manage 'list' commands the 'config list' option doesn't allow users to specify a filter to limit the output. This commit adds the ability to specify the flag the user wishes to display. If no flag is specified the default behavior is still to display all the configured flags. If the flag requested is not found, cinder-manage reports that the flag was not found. (fixes bug 1187137) Change-Id: I698f4c06d7e93217d8f307a880e0ae40711151c2
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
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!