openstack/heat
Code Issues Proposed changes
a5c7da576c
heat/doc
History
Dirk Mueller a5c7da576c Move qpid-python to test-requirements 
qpid-python is only needed if the qpid backend is actually used.
when it is part of requirements.txt, loading of heat-engine
(which is done via stevedore) fails as it forcefully requires
qpid-python then. However heat seems to work just fine without it.

Change-Id: I1c49ec709995da145849d8616fe7207908637fb9
2015-07-13 10:21:36 +02:00
..
docbkx
Change "ReST" to "REST" in developer doc
2015-06-03 21:26:29 +05:30
source
Move qpid-python to test-requirements
2015-07-13 10:21:36 +02: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.