History

Rabi Mishra 372a2376b8 Fix path_in_stack for scheduler hints Nova expects scheduler_hints to be a DictOfListOfStrings in the object layer(versioned objects), though there is no limitation for this in the api layer. Thefore sending a list of tuples as a scheduler_hint results in error. This also sets stack_scheduler_hints=true for integration tests. Change-Id: Id7575f67657fab86acb22d86807127dda45305d5 Closes-Bug: #1608452		2016-08-05 10:21:10 +00:00
..
docbkx	Replace github with openstack git repo	2015-10-21 09:51:40 +08:00
source	Fix path_in_stack for scheduler hints	2016-08-05 10:21:10 +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

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.