History

Jeff Peeler 69c662ac24 Rename docker directory to heat_docker This directory was renamed in 4e8231, which made importing docker (that is docker-py) difficult if not impossible in Python 2.x. So rename it to something other than 'docker' to avoid that problem. (setup.cfg has been modified with the new path) Change-Id: I3cbb7c5d4b53f70e1dc6102881f8e05852341a9a Related-bug: #1296758		2014-08-28 23:42:24 -04:00
..
docbkx	Remove heat-cli-guide	2014-01-15 08:41:48 +01:00
source	Rename docker directory to heat_docker	2014-08-28 23:42:24 -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.