openstack/heat

History

Colleen Murphy 28dd8117ba Update keystone_authtoken config reference The auth_uri parameter of keystonemiddleware was renamed to 'www_authenticate_uri'[1], so update the documentation accordingly. [1] https://review.opendev.org/508522 Change-Id: Ie3967064493fafb68df8e56f3d3dc097fbd19cc4		2019-06-12 15:08:39 -07:00
..
source	Update keystone_authtoken config reference	2019-06-12 15:08:39 -07: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	Blacklist bandit 1.6.0 and cap Sphinx on Python2	2019-05-14 16:50:24 -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.