openstack/nova

History

Dan Smith 68288b9cd2 Fix instance actions testing Somehow, the instance actions API was different in three places: 1. The actual API from a running system 2. The regular unit tests 3. The api_samples tests This fixes the fake_instance_actions module to look like the database model (which was the root of the problem) as well as the api_samples and regular unit tests to properly confirm the actual behavior I validated manually against a running system. This looks like it changes the external API, but in fact, it makes things match what the external API actually is. Change-Id: I0c8ddff3e0819a65667617083dfaa74f7317cc05		2013-08-07 08:11:08 -07:00
..
api_samples	Fix instance actions testing	2013-08-07 08:11:08 -07:00
ext	Remove usage of locals() for formatting from nova.api.*	2013-05-18 00:04:17 +04:00
source	Update references with new Mailing List location	2013-07-28 11:28:46 -07:00
README.rst	Fix inaccuracies in the development environment doc.	2013-02-11 09:29:48 -06:00

README.rst

OpenStack Nova Documentation README

Included documents:

developer reference guide(devref)
man pages

Building the docs

From the root nova directory:

python setup.py build_sphinx

Building just the man pages

from the root nova directory:

python setup.py build_sphinx -b man

Installing the man pages

After building the man pages, they can be found in doc/build/man/. You can install the man page onto your system by following the following steps:

Example for nova-scheduler:

mkdir /usr/local/man/man1
install -g 0 -o 0 -m 0644 doc/build/man/nova-scheduler.1  /usr/local/man/man1/nova-scheduler.1
gzip /usr/local/man/man1/nova-scheduler.1
man nova-scheduler