History

ricolin 83966b7bde Add `template_dir` to config Allow global environment contain global template files. This can lead to further access to global template files. For example a template file `my_tmpl.yaml` under global template directory (`/etc/heat/templates` by default) can be directly accessed in stack with `get_file`. Partial-Bug: #1454401 Change-Id: I0a1c9d50441f88144980214fbc8e6757193cfb41		2016-05-27 13:55:55 +08:00
..
docbkx	Replace github with openstack git repo	2015-10-21 09:51:40 +08:00
source	Add `template_dir` to config	2016-05-27 13:55:55 +08: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

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.