openstack/placement

History

annegentle 7ec8f661dd Removes RST documentation and moves it to openstack-manuals Avoiding redundant information and confusion. Change-Id: Iab1913ff359699db977b74554bad6088fab6ab2f		2012-04-30 12:45:48 -05:00
..
build	Updated sphinx layout to a two-dir layout like swift.	2010-07-24 18:06:22 -07:00
source	Removes RST documentation and moves it to openstack-manuals	2012-04-30 12:45:48 -05:00
.gitignore	Remove contrib/nova.sh and other stale docs.	2011-11-15 16:32:37 -05:00
README.rst	Fix rst formatting and cross-references	2012-03-06 08:08:25 -05: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 nova 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!