openstack/heat
Code Issues Proposed changes
9aee53d393
heat/doc
History
Peter Razumovsky 9aee53d393 Add properties grouping by necessity in docs 
Current resources page description has confusing
lists of properties, user have to search required
and optional properties, and this is unconvenient.
Add grouping by necessity of property: required and
optional.

Change-Id: I9b586faa21b275232bb5b323af4d4e1497d1a79b
Closes-bug: #1486549
2015-08-21 11:39:34 +03:00
..
docbkx
Change "ReST" to "REST" in developer doc
2015-06-03 21:26:29 +05:30
source
Add properties grouping by necessity in docs
2015-08-21 11:39:34 +03: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.