Files
senlin/doc
LinPeiWen 28f8abc29a Delete unavailable py2 package
The openstack Ussuri and Victoria versions no longer support the
Centos7 and pyrhon2 environment packages. Correct the missing
problems in the latest document

Change-Id: Ie17133b86f421868cddca46c29225d51ae671594
(cherry picked from commit 19c30d86ba)
2021-09-17 00:34:21 +00:00
..
2021-09-17 00:34:21 +00:00
2014-12-15 00:02:08 +08:00
2014-12-10 17:21:00 +08:00
2017-07-03 10:00:56 +02: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.

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.