openstack/heat
Code Issues Proposed changes
heat/doc
History
Steve Baker 98f687c1bc Organise doc links for Operating Heat 
The second section of doc links is aimed at operators, so existing
content which affects operators has been moved here (package based
install, scaling, service man pages).

The yum/apt install pages have been simplified to point at
docs.openstack.org and any other community based installation resources
(RDO, Juju charms).

Change-Id: I3e89a288bf6b64ba286c11df1369e073d2c2a35e
2015-10-06 11:38:14 +13:00
..
docbkx
Change "ReST" to "REST" in developer doc
2015-06-03 21:26:29 +05:30
source
Organise doc links for Operating Heat
2015-10-06 11:38:14 +13: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.