History

Anderson Mesquita c762782284 Remove warnings when generating docs

Improve docstrings so that syntax warnings are no longer displayed when
generating docs.

Related-Bug: 1403897
Change-Id: I0163bc7f83e00f9077fc78e638173df2124580dd

2014-12-19 19:16:54 +00:00

docbkx

Remove heat-cli-guide

2014-01-15 08:41:48 +01:00

source

Remove warnings when generating docs

2014-12-19 19:16:54 +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.