Files

Zane Bitter 40ec766568 Docs: Fix links broken since Train release

Change-Id: Iccd1185c697d3c44c887ee69ef403c8c4c9ef6fb

2020-01-23 12:31:27 -05:00

2020-01-23 12:31:27 -05:00

.gitignore

2012-12-19 10:22:35 +13:00

Makefile

2014-07-02 22:08:01 +02:00

README.rst

Switch over to oslosphinx

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

requirements.txt

2019-11-01 11:30:12 +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.

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.