History

Tyler Adams 6b15b97689 Remove executable permissions from files that don't need it Many python files have their executable permissions flag set but they shouldn't Removed executable flag from files that did not need it Closes-Bug: #2055736 Change-Id: Ic04051fdc597b2f915f76e4c4c47f392354ddfe1		2024-03-02 00:14:48 +00:00
..
source	Add the lost component when in installation	2022-11-10 10:18:08 +08:00
specs	Remove executable permissions from files that don't need it	2024-03-02 00:14:48 +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.