nova/doc
Nikola Dipanov e81e93cab4 Integration tests virtual interfaces API extension
Adds tests and templates for testing of the virtual interfaces
API extension. Tests both json and XML API functionality.

Change-Id: I95f4e6667c3c2df123246d73498f13d826e3866a
(cherry picked from commit 7090ef9437)
2012-09-24 16:14:50 -07:00
..
api_samples Integration tests virtual interfaces API extension 2012-09-24 16:14:50 -07: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