openstack/cinder

History

Alex Meade 53cfde43b8 User messages API for error cases This patch implements basic user messages with the following APIs. GET /messages GET /messages/<message_id> DELETE /messages/<message_id> Implements : blueprint summarymessage Co-Authored-By: Alex Meade <mr.alex.meade@gmail.com> Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com> Change-Id: Id8a4a700c1159be24b15056f401a2ea77804d0a0		2016-04-29 18:41:10 +00:00
..
ext	Replace xrange() with six.moves.range()	2015-06-16 10:46:40 +02:00
source	User messages API for error cases	2016-04-29 18:41:10 +00:00
.gitignore	Initial fork out of Nova.	2012-05-03 10:48:26 -07:00
find_autodoc_modules.sh	Fixes a small issue in find_autodoc_modules.sh	2015-01-23 14:38:44 +08: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	Complete the doc/README.rst instructions to build docs	2015-04-16 08:13:04 +00: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

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

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 docs

The docs have been built

Check out the build directory to find them. Yay!