History

Zuul d5d3bb9307 Merge "Add doc description for stop_timeout_before_update"		2021-11-28 23:03:47 +00:00
..
source	Merge "Add doc description for stop_timeout_before_update"	2021-11-28 23:03:47 +00:00
specs	add line to fix Unexpected indentation	2018-11-07 16:15:18 +00:00
.gitignore	Initial version	2014-12-15 00:02:08 +08:00
Makefile	Initial version copied from Heat	2014-12-10 17:21:00 +08:00
README.rst	Remove senlin-admin skeleton	2017-07-03 10:00:56 +02:00
requirements.txt	Switch to newer openstackdocstheme and reno versions	2020-05-22 17:15:04 +08:00

Building the developer docs

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.