History

ricolin ba86129965 Remove potential co-gating integration tests This patch propose to use heat tempest plugin for potential co-gating integration tests. These tests are consider as potential co-gating. And we now already maintain them in heat tempest plugin. This also disables all except two of the gate/test jobs, to enable us to land this series and stop the carnage. The jobs will be re-enabled once all of the duplicated tests have been eliminated. Change-Id: I55e204b72cd5a2876576852b10ad09f24d04beb4		2018-01-26 17:50:26 -05:00
..
source	Remove potential co-gating integration tests	2018-01-26 17:50:26 -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

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.