Files
nova/doc
Ken'ichi Ohmichi 38c17db30a Fix sample parameter of agent API
The parameter of agent update API has been changed from "para" to
"agent" since Nova v3 API, and this patch fixes the sample doc.

Partially implements blueprint v3-api-specification

Change-Id: Ic9c0f11a637e48daa9457ab9ae923fefc0fb350d
2013-11-19 15:25:09 +09:00
..

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