History

Ghanshyam Mann 29c0e6fbdf [ussuri][goal] Drop python 2.7 support and testing OpenStack is dropping the py2.7 support in ussuri cycle. Senlin is ready with python 3 and ok to drop the python 2.7 support. Complete discussion & schedule can be found in - http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html - https://etherpad.openstack.org/p/drop-python2-support Ussuri Communtiy-wide goal: https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html Depends-On: https://review.opendev.org/#/c/693631/ Change-Id: I0377788d0db0e60d44c35f1d26eefd58502a452a		2019-11-17 17:48:53 +00:00
..
source	Bump the openstackdocstheme extension to 1.20	2019-11-15 02:47:26 +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	[ussuri][goal] Drop python 2.7 support and testing	2019-11-17 17:48:53 +00: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.