openstack/heat
Code Issues Proposed changes
heat/doc
History
Zane Bitter c26cf90325 Create a new revision of HOT for Juno 
The next revision of HOT, dated 2014-10-16 to coincide with the Juno
release date, will support the list_join function and remove support for
the CFN-style functions. There may also be other changes throughout the
Juno development cycle.

Change-Id: I20d9586201806ac34e303689660ff565cb9f2b5c
2014-07-15 10:21:56 -04:00
..
docbkx
Remove heat-cli-guide
2014-01-15 08:41:48 +01:00
source
Create a new revision of HOT for Juno
2014-07-15 10:21:56 -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.