openstack/deb-heat
Code Issues Proposed changes
9b53378e27
deb-heat/doc
History
Steve Baker c1be1264b9 Functions documentation cleanup. 
- Switched to definition lists for parameters to be consistent
  with generated resource docs
- Make consistent the layout of literal blocks and returns
- Other minor grammatical and layout fixes

Change-Id: I62eb179ce2a20024d2195cc7eb88e2e79bd4ae68
2013-07-27 11:37:32 +12:00
..
docbkx API support for Environments 2013-06-17 20:26:28 +10:00
source Functions documentation cleanup. 2013-07-27 11:37:32 +12: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