openstack
/
deb-heat
Code Issues Proposed changes
deb-heat/doc
History
Peter Razumovsky c16de3f5a1 Add info to docs about heat devstack plugin 
Since Newton release heat devstack plugin will be available,
so need to add info about that to documentation.

Change-Id: Ie2503fbdd9e3f72c20889a675664fb5149d2b287
Closes-bug: #1610987
(cherry picked from commit a7c7945d01)
 		2016-10-25 05:52:56 +00:00
..
docbkx Replace github with openstack git repo 2015-10-21 09:51:40 +08:00
source Add info to docs about heat devstack plugin 2016-10-25 05:52:56 +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

README.rst

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.

Get Help

Just type make to get help:

make

It will list available build targets.

Build Doc

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

Test Doc

If you modify doc files, you can type:

make doctest

to check whether the format has problem.