openstack/heat
Code Issues Proposed changes
8ae5f8657b
heat/doc
History
Zane Bitter 63bff7408a Revert "Change "services" to "service"" 
This was correct for the RDO installation guide.

This reverts commit b90278b503.

Change-Id: I5107e712a903f334f1a3a996b9140e9e2fe0807a
2018-10-18 17:23:34 +00:00
..
source Revert "Change "services" to "service"" 2018-10-18 17:23:34 +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
requirements.txt Replace pbr autodoc with sphinxcontrib-apidoc 2018-04-11 16:35:01 -04: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.