openstack/nova

History

Jenkins 234e0a346f Merge "Add V3 API samples for security-groups"		2013-09-26 18:04:07 +00:00
..
api_samples	Merge "Add os-assisted-volume-snapshots extension"	2013-09-04 00:35:21 +00:00
ext	Remove usage of locals() for formatting from nova.api.*	2013-05-18 00:04:17 +04:00
source	Merge "Remove out of date list of jenkins jobs"	2013-09-11 14:24:11 +00:00
v3/api_samples	Merge "Add V3 API samples for security-groups"	2013-09-26 18:04:07 +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