openstack/placement

History

Sascha Peilicke df2391578f Drop nova-rpc-zmq-receiver man-page Doesn't make sense to install and build docs after it was removed. Change-Id: Ia6193808cca625e83cb3497b5033db5c08dcdd1e		2014-04-01 11:06:33 +02:00
..
api_samples/os-aggregates	Enable Aggregate based availability zones	2013-01-08 14:00:41 -08:00
source	Drop nova-rpc-zmq-receiver man-page	2014-04-01 11:06:33 +02:00
v3/api_samples/os-aggregates	Fix the indents of v3 API sample docs	2014-02-18 03:18:09 +09:00
README.rst	Replace oslo.sphinx with oslosphinx	2014-02-12 16:45:49 +00: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 oslosphinx.

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