History

Peter Razumovsky 5d32fae826 Rename source_path in translation

Rename source_path to translation_path in translation,
which clarifies, that the path means where we should do
changes.

Change-Id: I8ffc157dee95e9f5507773b3cf4969cf9a2a289b

2016-04-09 02:16:18 +00:00

docbkx

Replace github with openstack git repo

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

source

Rename source_path in translation

2016-04-09 02:16:18 +00: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.