History

Steve Baker 25f707cdf0 Use sections for individual properties and attributes It is often helpful to point people at the documentation for a specific attribute or property. This change achieves this by using sections instead if definition items to format the documentation of a property/attribute. Complex property schemas are indented using block quotes and the fragment identifier is appended to so that each link is unique. (eg, #OS::Ceilometer::Alarm-prop-query-*-field) The 'required' and 'optional' sections have been brought up one level, replacing 'Properties' with 'Required Properties' and 'Optional Properties'. Closes-Bug: #1486429 Change-Id: Ifd497aac74e8aff76ea91a295df17bb1da949ba8		2015-08-27 09:59:25 +12:00
..
docbkx	Change "ReST" to "REST" in developer doc	2015-06-03 21:26:29 +05:30
source	Use sections for individual properties and attributes	2015-08-27 09:59:25 +12: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

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.

Just type make to get help:

make

It will list available build targets.

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

If you modify doc files, you can type:

make doctest

to check whether the format has problem.