History

Samuel de Medeiros Queiroz 82ba0dd68f Create a guide for scaling out Heat API's This documentation describes a guide for scaling out the ReST and CFN API's based on a devstack installation. HAProxy is used as a load balancer, redirecting calls from CLI to the several API's instances. Change-Id: I6efe988ce970f2a3aa08f39050f85dc1621e6774 Closes-bug: #1072958		2013-11-06 18:03:11 -03:00
..
docbkx	Begin 3 chapters for Orch API Ref Manual	2013-10-09 10:04:33 -05:00
source	Create a guide for scaling out Heat API's	2013-11-06 18:03:11 -03:00
.gitignore	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
Makefile	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
README.rst	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00

README.rst

Building the developer docs

For user and admin docs, go to the directory doc/docbkx.

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.

sudo yum install python-sphinx
sudo pip-python install sphinxcontrib-httpdomain

Use make

Just type make:

make

Look in the Makefile for more targets.

To build the man pages:

make man

To build the developer documentation as HTML:

make html