openstack
/
senlin
Code Issues Proposed changes
senlin/doc
History
LinPeiWen 90d26685e8 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)
(cherry picked from commit 28f8abc29a)
 		2021-12-05 06:56:59 +00:00
..
source Delete unavailable py2 package 2021-12-05 06:56:59 +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

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.