senlin/doc
Erik Olof Gunnar Andersson 01eff94b76 Centralized configuration
Based upon the established conf paradigm used in Nova,
this patch moves the configuration to a central location.
Making config a lot easier to manage, as well a lot easier
to locate.

Additional changes
* Fixed missing notification section in example config.
* Moved external configs to generator config (e.g. osprofiler)

Change-Id: I8bca356768bd710d28361b50754ddcc249a32428
2019-12-03 11:08:44 -08:00
..
source Centralized configuration 2019-12-03 11:08:44 -08: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

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.