openstack/nova

History

Kaushik Chandrashekar b27a6cb399 API to get the Cell Capacity The total RAM and the available RAM are stored in memory of CellStateManager. This API gets the available slots per flavor for a given cell. Implements: blueprint get-cell-free-ram Change-Id: I2a6dbb8835cad04f3ee058c3012490782d7c8e67		2013-06-05 12:52:55 -05:00
..
api_samples	API to get the Cell Capacity	2013-06-05 12:52:55 -05:00
ext	Remove usage of locals() for formatting from nova.api.*	2013-05-18 00:04:17 +04:00
source	Fixed two minor docs niggles.	2013-05-31 08:30:13 -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