History

huangtianhua 5cdebb5e05 Remove 'adding-new-users-to-devstack' doc on_devstack.rst Since https://review.openstack.org/#/c/128509/ heat no longer requires the "heat_stack_owner" role by default, as we now delegate all roles via the trust. So remove the 'adding-new-users-to-devstack' doc. Change-Id: Ia84e72b7b0cb4a1a2f40fc8bd259f99fc495de82		2015-02-13 12:12:01 +08:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Remove 'adding-new-users-to-devstack' doc on_devstack.rst	2015-02-13 12:12:01 +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.