openstack/heat
Code Issues Proposed changes
heat/doc
History
Mark Vanderwiel 6b837a85ff Add table of custom constraints to hot spec 
Added a generic sphinx extension to allow text from a file to
be pulled into the documentation in simple table format.
It allows flexibility to be used for other types of
list of heat configuration data in the future.

Change-Id: I96c936df3bc42c385e73a8dc76c0f9a29e17ea3f
Closes-Bug: #1453718
2015-09-18 18:53:16 -05:00
..
docbkx
Change "ReST" to "REST" in developer doc
2015-06-03 21:26:29 +05:30
source
Add table of custom constraints to hot spec
2015-09-18 18:53:16 -05: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.