History

Dao Cong Tien e8824a2c93 Adds doc8 check to pep8 This patch adds doc8 check for .rst files to pep8. Files that fail doc8 check are also fixed. Ignore D001 of doc8 check. This requires lot of changes and should be done in a separated patch. Change-Id: I7732abc55ec27026efbf56663ba02ff27e8ec847		2018-07-26 14:57:58 +07:00
..
source	Adds doc8 check to pep8	2018-07-26 14:57:58 +07:00
.gitignore	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
Makefile	Makefile option to build xml docs	2014-07-02 22:08:01 +02:00
README.rst	Switch over to oslosphinx	2014-02-13 18:45:57 +01:00
requirements.txt	Replace pbr autodoc with sphinxcontrib-apidoc	2018-04-11 16:35:01 -04: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.