nova/doc at fe5f22de04776e95bd6c5bc88210b6dd88bf82aa - nova

womax/nova

Files

T

Ken'ichi Ohmichi fe5f22de04 Change v3 version API to v2.1

This patch changes v3 version API to v2.1 and makes v2 unit tests
share between v2 and v2.1.
v2.1 API does not support XML format. Unit tests related to XML
don't work against v2.1.

Partially implements blueprint v2-on-v3-api

Change-Id: I7abadb0c9082b9e90a98938967f0e27d1a2fa766

2014-08-30 07:08:59 +00:00

api_samples

Change v3 version API to v2.1

2014-08-30 07:08:59 +00:00

ext

Remove usage of locals() for formatting from nova.api.*

2013-05-18 00:04:17 +04:00

source

filter: add per-aggregate filter to configure max_instances_per_host

2014-08-26 21:39:13 +00:00

v3/api_samples

Merge "Convert multinic v3 plugin to v2.1"

2014-08-28 06:27:37 +00: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