senlin/doc/README.rst
Andreas Jaeger e96056a69a Remove senlin-admin skeleton
This directory is just a skeleton with no real contents. Remove it.

Change-Id: I2fbee9651e4dfb9426db24d118de30787bdac1ee
2017-07-03 10:00:56 +02:00

689 B

Building the developer docs

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.