openstack/nova

History

Christopher Yeoh d090d3d8c6 Removes os-simple-tenant-usage from the V3 API The extension pre-dates ceilometer and equivalent functionality is now much better managed using ceilometer. So we're removing this before the V3 API is officially released. Partially implements blueprint v3-api-remove-extensions Change-Id: Ia8fd475e6f0c4dbc67f3c47279cbaa2280b3af0b		2014-02-08 22:55:01 -07:00
..
api_samples	Adds RDP console support	2014-02-07 21:20:08 +02:00
ext	Remove usage of locals() for formatting from nova.api.*	2013-05-18 00:04:17 +04:00
source	Fix misspellings in nova	2014-02-07 13:09:24 +08:00
v3/api_samples	Removes os-simple-tenant-usage from the V3 API	2014-02-08 22:55:01 -07:00
README.rst	Add explicit discussion of dependencies to README.rst	2014-01-20 23:07:34 -05:00

README.rst

OpenStack Nova Documentation README

Included documents:

developer reference guide(devref)
man pages

Dependencies

Building this documentation can be done in a regular Nova development environment, such as the virtualenv created by run_tests.sh or tools/install_venv.py. A leaner but sufficient environment can be created by starting with one that is suitable for running Nova (such as the one created by DevStack) and then using pip to install oslo.sphinx.

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