History

Rabi Mishra f3efe1de29 Ensure _static exists with placeholder openstack-tox-docs is failing with below error. Warning, treated as error: html_static_path entry '_static' does not exist Change-Id: Ic6f5a463f0ec95537ebea0855ebd71d4e4ed5df4		2019-08-23 09:25:22 +05:30
..
source	Ensure _static exists with placeholder	2019-08-23 09:25:22 +05:30
.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	Blacklist sphinx 2.1.0 (autodoc bug)	2019-07-30 16:53:08 +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.