openstack/deb-cinder
Code Issues Proposed changes
f34aef3a29
deb-cinder/doc
History
Jay S. Bryant 4f242adb4e Re-write of the cinder-manage man page. 
The cinder-manage man page didn't appear to have been re-written
since splitting from Nova.  There were numerous options that
no longer exist documented and references to Nova instead of
Cinder.

This version has been re-written based on the current code in
cinder-manage.

(fixes bug 1174502)

Change-Id: Ia03ca05bbd87444b2213bf719da0ffff96b67699
2013-06-03 15:50:09 -05:00
..
ext Fix PEP8 issues. 2012-08-28 23:28:48 +08:00
source Re-write of the cinder-manage man page. 2013-06-03 15:50:09 -05:00
.gitignore 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
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

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!