History

Jeremy Stanley 9b545a00b8 Workflow documentation is now in infra-manual

Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: I7ab5c3b3adf08844296e479922af8195ec7d6603

2014-12-05 03:30:46 +00:00

source

Workflow documentation is now in infra-manual

2014-12-05 03:30:46 +00:00

.gitignore

docs: autogenerate docs w/ module docstrings

2014-03-19 08:51:10 -05:00

Makefile

Prepare doc building

2014-01-28 16:18:14 -06:00

README.rst

docs: autogenerate docs w/ module docstrings

2014-03-19 08:51:10 -05:00

README.rst

Building the developer docs

Dependencies

You'll need to install python Sphinx package package:

sudo pip install sphinx

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.