History

Thomas Herve 81e1acfe72 Improve resource types list rendering https://docs.openstack.org/heat/latest/template_guide/openstack.html looks a bit messy right now, this tries to make some improvements: * Reduce the TOC depth * Improve version messages * Indent property description * Fix map/list properties rendering Change-Id: I1571d1af9eba2619f8db64c54ad0b141b354a524		2018-07-25 09:46:57 +02:00
..
source	Improve resource types list rendering	2018-07-25 09:46:57 +02:00
.gitignore	A new documention structure, ready for contributions	2012-12-19 10:22:35 +13:00
Makefile	Makefile option to build xml docs	2014-07-02 22:08:01 +02:00
README.rst	Switch over to oslosphinx	2014-02-13 18:45:57 +01:00
requirements.txt	Replace pbr autodoc with sphinxcontrib-apidoc	2018-04-11 16:35:01 -04:00

Building the developer docs

For user and admin docs, go to the directory doc/docbkx.

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.

Just type make to get help:

make

It will list available build targets.

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

If you modify doc files, you can type:

make doctest

to check whether the format has problem.