Pavlo Shchelokovskyy 3ea6e8c54f Fix a typo in the README for docs

Package `oslo.sphinx` is wronlgy referred to as `oslo-sphinx`.

Change-Id: I15711aa54c82d97b622fbceb821b4aca3315d49c

2013-12-24 16:08:41 +02: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 oslo.sphinx package:

sudo pip install sphinx oslo.sphinx

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.