nova/doc
Jinwoo 'Joseph' Suh c75e81e003 Added description of operators for extra_specs
There are several new operators added for extra_specs that are used
in compute capability filter and aggregate filter. These are
described in document in this patch. Fixed bug 1047036.

Change-Id: Id86c6672d7bda458ecb918f1900d6f8a9526ad41
2012-09-21 11:25:03 +02:00
..
api_samples Add Keypairs extension to API samples test. 2012-09-18 20:49:59 -04:00
ext Fix PEP8 issues. 2012-08-28 23:13:11 +08:00
source Added description of operators for extra_specs 2012-09-21 11:25:03 +02:00
README.rst Fix doc/README.rst to render properly 2012-09-18 11:42:51 -07:00

README.rst

OpenStack Nova Documentation README

Included documents:

  • developer reference guide(devref)
  • man pages

Building the docs

From the root nova director:

python setup.py build_sphinx

Building just the man pages

from the root nova director:

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-manage:

mkdir /usr/local/man/man1
install -g 0 -o 0 -m 0644 doc/build/man/nova-manage.1  /usr/local/man/man1/nova-manage.1
gzip /usr/local/man/man1/nova-manage.1
man nova-manage