Files

pengyuesheng 179a4a4ab0 Sync Sphinx requirement

Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.

Change-Id: Ia34415e18f3c3c10ba3c669967cf4f5ab0e6ad11

2019-08-01 17:11:15 +08:00

source

Update api-ref location

2019-07-22 19:19:20 +02: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

Sync Sphinx requirement

2019-08-01 17:11:15 +08:00

README.rst

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.

Get Help

Just type make to get help:

make

It will list available build targets.

Build Doc

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

Test Doc

If you modify doc files, you can type:

make doctest

to check whether the format has problem.