openstack/heat

History

Zane Bitter 6c8697442e Do deep redirects from old docs.openstack.org URLs The docs.openstack.org site was rearranged so that the old docs at /developer/heat/ are now at /heat/latest/. The base .htaccess file in openstack-manuals redirects everything in the old hierarchy to the root of the new one unless there is a .htaccess file present (see I0af0e32d9c646d61f4c72599cdc4613299aa5ec9). Add a .htaccess file so that old links redirect to the equivalent page in the new location. Change-Id: I74de09f4e25c2eda050053d3b8646586c9f24c04 Closes-Bug: #1722820		2017-11-02 16:25:01 -04:00
..
source	Do deep redirects from old docs.openstack.org URLs	2017-11-02 16:25:01 -04: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.