01eff94b76
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 |
||
---|---|---|
.. | ||
source | ||
specs | ||
.gitignore | ||
Makefile | ||
README.rst | ||
requirements.txt |
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.