Files

Russell Bryant 592185c242 Remove v3 xml API sample tests

This is a step toward removing XML support from the v3 compute API.
First, we need to remove all of the tests that would fail once we start
ripping out the real code.

Part of blueprint remove-v3-xml-api

Change-Id: Ie2c280d5ea1e6b8756535deb05982a92561552db

2014-01-28 17:01:44 -05:00

api_samples/os-aggregates

Enable Aggregate based availability zones

2013-01-08 14:00:41 -08:00

source

Fix formatting errors in documentation

2013-07-06 13:18:11 -04:00

v3/api_samples/os-aggregates

Remove v3 xml API sample tests

2014-01-28 17:01:44 -05: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