History

ricolin 9087f24881 Add note for env prepare of Custom image script

Add note for `Custom image script` to make sure everyone
aware of requirements of environment before running the scripts.
Closes-Bug: #1651237

Change-Id: Ic9874765ff3d1925c4edf3b2b1b766cddaee550a

2017-01-08 00:34:18 +08:00

docbkx

Replace github with openstack git repo

2015-10-21 09:51:40 +08:00

source

Add note for env prepare of Custom image script

2017-01-08 00:34:18 +08: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

README.rst

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.

Get Help

Just type make to get help:

make

It will list available build targets.

Build Doc

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

Test Doc

If you modify doc files, you can type:

make doctest

to check whether the format has problem.