openstack/nova

History

Oleg Bondarev e354a56933 Add "ExtendedVolumes" API extension - adds an API extension to include list of attached volumes with instance info - adds v3 api porting as well DocImpact Implements blueprint servers-add-volume-list Change-Id: If58dc40b093c2f61c6ae6b82fcd8f0bf53be464a		2013-07-10 11:09:21 +04:00
..
api_samples	Add "ExtendedVolumes" API extension	2013-07-10 11:09:21 +04:00
ext	Remove usage of locals() for formatting from nova.api.*	2013-05-18 00:04:17 +04:00
source	Use oslo.sphinx and remove local copy of doc theme	2013-07-06 13:18:04 -04: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