Files
deb-senlin/doc
jonnary c0905e8be3 Revise ex_lbas.yaml cannot be found
After tox build, *.yaml file will be lost.
Change ex_lbas.yaml link to github source code.

Change-Id: I196a837aba708f3882a476badaea6ec70e754803
2016-11-16 09:15:08 +00:00
..
2016-03-29 11:49:51 +07:00
2014-12-15 00:02:08 +08:00
2014-12-10 17:21:00 +08:00
2014-12-10 17:21:00 +08: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 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.