openstack/nova

History

Jenkins d83c9a6aa0 Merge "Added a new scheduler metrics weight plugin"		2013-12-07 20:05:10 +00:00
..
api_samples	Remove V2 API version of coverage extensions	2013-11-18 22:35:39 +10:30
ext	Remove usage of locals() for formatting from nova.api.*	2013-05-18 00:04:17 +04:00
source	Added a new scheduler metrics weight plugin	2013-12-05 11:14:31 +08:00
v3/api_samples	Merge "Remove traces of V3 personality extension from api samples"	2013-12-07 04:22:43 +00: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