openstack/deb-heat
Code Issues Proposed changes
1584bc17bb
deb-heat/doc
History
Jenkins ef54dc48dd Merge "Fix the main docs index page"
2013-08-23 06:33:39 +00:00
..
docbkx Rename Quantum to Neutron 2013-08-06 22:08:27 -07:00
source Merge "Fix the main docs index page" 2013-08-23 06:33:39 +00: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