History

tengqm 02cdcc7d71 Initial version of authorization doc This is an initial version of the design doc for authentication and authorization in Senlin. There will be future improvements and revisions. Change-Id: I5f3d3dc1fb14237e357d1520ef1755626e2744ed		2015-04-16 04:17:37 -04:00
..
api-site	Revised API doc for events	2015-03-07 10:38:55 +08:00
docbkx	Removed old files that are useless now	2015-01-14 13:00:52 +08:00
source	Initial version of authorization doc	2015-04-16 04:17:37 -04:00
.gitignore	Initial version	2014-12-15 00:02:08 +08:00
Makefile	Initial version copied from Heat	2014-12-10 17:21:00 +08:00
README.rst	Initial version copied from Heat	2014-12-10 17:21:00 +08:00

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.

Just type make to get help:

make

It will list available build targets.

To build the man pages:

make man

To build the developer documentation as HTML:

make html

Type make for more formats.

If you modify doc files, you can type:

make doctest

to check whether the format has problem.