openstack
/
heat
Code Issues Proposed changes
heat/doc
History
Zane Bitter 3eac2a4d54 Docs: Remove contrib/rackspace section from template guide 
We removed the contrib/rackspace directory in
13a5b43d65, so remove the now-empty
section in the template guide for the resource plugins it formerly
contained.

Change-Id: Id2bf166990c27a2ac0be38e5bdd19548e74d8f60
 		2018-03-12 18:39:20 -04:00
..
source Docs: Remove contrib/rackspace section from template guide 2018-03-12 18:39:20 -04:00
.gitignore A new documention structure, ready for contributions 2012-12-19 10:22:35 +13:00
Makefile Makefile option to build xml docs 2014-07-02 22:08:01 +02:00
README.rst Switch over to oslosphinx 2014-02-13 18:45:57 +01:00

README.rst

Building the developer docs

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

Dependencies

You'll need to install python Sphinx package and oslosphinx package:

sudo pip install sphinx oslosphinx

If you are using the virtualenv you'll need to install them in the virtualenv.

Get Help

Just type make to get help:

make

It will list available build targets.

Build Doc

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

Test Doc

If you modify doc files, you can type:

make doctest

to check whether the format has problem.