History

Adalberto Medeiros a94176e15b Add os-volumes extension to api samples Add samples and templates to api samples for volumes extensions Fixes: bug 1071338 Implements: blueprint nova-api-samples Change-Id: Ia021cc4d6c29ccaa3e81f4c5fdbb7e88d9f02dc6		2013-03-01 11:31:25 -03:00
..
api_samples	Add os-volumes extension to api samples	2013-03-01 11:31:25 -03:00
ext	Fix PEP8 issues.	2012-08-28 23:13:11 +08:00
source	Update OpenStack LLC to Foundation	2013-02-26 19:15:29 -05: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