openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Jay S. Bryant 15bd189235 Add flag argument to 'cinder-manage config list' 
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
 		2013-07-15 13:40:38 -05:00
..
ext Fix PEP8 issues. 2012-08-28 23:28:48 +08:00
source Add flag argument to 'cinder-manage config list' 2013-07-15 13:40:38 -05:00
.gitignore Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
Makefile Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
README.rst Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
find_autodoc_modules.sh Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
generate_autodoc_index.sh Initial fork out of Nova. 2012-05-03 10:48:26 -07:00

README.rst

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

  1. Generate the code.rst file so that Sphinx will pull in our docstrings:

    % ./generate_autodoc_index.sh > source/code.rst

  2. Run `sphinx_build`:

    % sphinx-build -b html source build/html

The docs have been built

Check out the build directory to find them. Yay!