History

Miguel Grinberg 6311fa3050 Add unsupported resources page to documentation This change adds a new page to the sphinx documentation that lists all the resources that are not officially supported, such as those marked as deprecated, unsupported, prototype, etc. Change-Id: I0a14899f4f9e1539242f898f2d74d2677689d260		2015-05-28 14:58:46 -07:00
..
docbkx	changed heat dev docs to comply with conventions	2015-04-24 22:03:07 -04:00
source	Add unsupported resources page to documentation	2015-05-28 14:58:46 -07: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.