heat/doc
ricolin 203bce9cd7 Switch to use opendev.org
Our cgit instance will be going away and opendev.org is the new
preferred URL for browsing our git repos. Redirects will exist for the
foreseeable future, but it's more efficient to just go directly to the
new locations.

Change-Id: Ic5fa1a8436f57836ad37b752a0cca1cd4f3a21a7
2019-04-22 09:36:50 +05:30
..
source Switch to use opendev.org 2019-04-22 09:36:50 +05:30
.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.