History

Thomas Herve ae6711d661 Make a backward compatible docutils fix THe fix for docutils 0.13 doesn't work with 0.12, obviously. This works around the issue handling both version of the internal API. Change-Id: I3bebb206a3205a6f3fa77a7844e50c2e090630a4		2017-03-06 09:13:16 +01:00
..
docbkx	Replace github with openstack git repo	2015-10-21 09:51:40 +08:00
source	Make a backward compatible docutils fix	2017-03-06 09:13:16 +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.