OpenStack Orchestration (Heat)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ricolin 203bce9cd7 Switch to use opendev.org 6 days ago
..
source Switch to use opendev.org 1 day ago
.gitignore A new documention structure, ready for contributions 6 years ago
Makefile Makefile option to build xml docs 4 years ago
README.rst Switch over to oslosphinx 5 years ago
requirements.txt Replace pbr autodoc with sphinxcontrib-apidoc 1 year ago

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.