History

Tovin Seven fc8eb842b3 Trivial: Update pypi url to new url Pypi url changed from [1] to [2] [1] https://pypi.python.org/pypi/<package> [2] https://pypi.org/project/<package> Co-Authored-By: Van Hung Pham <hungpv@vn.fujitsu.com> Change-Id: I07e2ecb62076610867568765f25c90e2ccbbd895		2018-08-31 04:07:35 +00:00
..
source	Trivial: Update pypi url to new url	2018-08-31 04:07:35 +00: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.