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.
heat/doc
Angus Salkeld 95ac80a0d5
API support for Environments
10 years ago
..
docbkx API support for Environments 10 years ago
source Fix various Sphinx errors/warnings 10 years ago
.gitignore A new documention structure, ready for contributions 10 years ago
Makefile A new documention structure, ready for contributions 10 years ago
README.rst A new documention structure, ready for contributions 10 years ago

README.rst

Building the developer docs

For user and admin docs, go to the directory doc/docbkx.

Dependencies

Sphinx

You'll need sphinx (the python one) and if you are using the virtualenv you'll need to install it in the virtualenv specifically so that it can load the cinder modules.

sudo yum install python-sphinx
sudo pip-python install sphinxcontrib-httpdomain

Use make

Just type make:

make

Look in the Makefile for more targets.

To build the man pages:

make man

To build the developer documentation as HTML:

make html