Dirk Mueller e53f7792ad Switch over to oslosphinx

oslosphinx is now available as a replacement for oslo.sphinx that
won't conflict with oslo.config in virtual envs

Change-Id: I7dc3349c8102cc8f358de7e0088128b6705c5f8e
Closes-Bug: #1277168

2014-02-13 18:45:57 +01:00

749 B

Raw Blame History

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.

749 B Raw Blame History