History

Shuangtai Tian 1b0d1bebae Fix a bug in v3 API doc This patch changes the wrong variable names 'addFixedIp' and 'networkId', which were not used in V3 multinic API. We use 'add_fixed_ip' and 'network_id' in V3 multinic API. Closes-bug: #1265716 Change-Id: I0c91764603d941df6d011a3b1266eb354c0bc54f		2014-02-03 18:16:34 +08:00
..
api_samples	Add preserve_ephemeral option to rebuild	2014-01-16 16:24:05 +02:00
ext	Remove usage of locals() for formatting from nova.api.*	2013-05-18 00:04:17 +04:00
source	Merge "Define "supported_instances" for fake compute"	2014-01-30 15:48:09 +00:00
v3/api_samples	Fix a bug in v3 API doc	2014-02-03 18:16:34 +08: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