History

Peter Razumovsky a43e2c95d8 Add documentation page for Support Status

Add documentation page with Support Status usage guide.
It contains information about deprecation process and
description how to use SupportStatus class.

bp deprecating-improvements

Change-Id: Iaee7334006997fc154edaddae3d78e617fb2cb82

2015-07-20 10:53:55 +03:00

docbkx

Change "ReST" to "REST" in developer doc

2015-06-03 21:26:29 +05:30

source

Add documentation page for Support Status

2015-07-20 10:53:55 +03: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.