openstack/deb-heat
Code Issues Proposed changes
7d1281eb91
deb-heat/doc
History
ZhiQiang Fan 82b7aa6c6c Replace OpenStack LLC with OpenStack Foundation 
Change-Id: Ia3489a1cff5070b000098e278c772cb823ae688c
Fixes-Bug: #1214176
2013-09-20 02:43:12 +08:00
..
docbkx Replace OpenStack LLC with OpenStack Foundation 2013-09-20 02:43:12 +08:00
source Replace OpenStack LLC with OpenStack Foundation 2013-09-20 02:43:12 +08: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