History

Bertrand Lallau ef5a2976b2 Update instructions to generate GMR error reports Guru Meditation Reports (GMR) code in oslo.reports was recently updated to expect SIGUSR2 as opposed to SIGUSR1, because it is reserved by Apache 'mod_wsgi' for its own use. [1] https://review.openstack.org/#/c/223133/ -- guru_meditation_report: Use SIGUSR2 instead of SIGUSR1 Change-Id: I4dbf1a11d3737c4a8444b3a79de824acecb56d7d		2015-11-04 13:38:17 +01:00
..
docbkx	Replace github with openstack git repo	2015-10-21 09:51:40 +08:00
source	Update instructions to generate GMR error reports	2015-11-04 13:38:17 +01: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.