History

Praveen Yalagandula f18788ecd8 Install guide bug fix: incorrect auth_uri for ec2authtoken Keystone doesn't expose /ec2tokens path on non-versioned base url. So when auth_uri under ec2authtoken section in heat.conf is set to non-versioned keystone url (e.g., http://localhost:5000), heat-api-cfn's calls for authentication return 404 (Not Found) error. This fix updates the install guides to specify proper versioned url for auth_uri param. Note this is a stable branch only fix due to Ie11139a5d9a176037f1c9f50a62ff6dbd1b20b8f landing on master Change-Id: If6eeff7d3212d71891311a4506ec6be4a1a30fa2		2017-09-28 07:57:21 +00:00
..
source	Install guide bug fix: incorrect auth_uri for ec2authtoken	2017-09-28 07:57:21 +00: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.