nova/doc at 5e6b6b044b2ce3d2ae033ce756dc7473ade9c134 - nova

womax/nova

Files

T

Eli Qiao 5e6b6b044b Change v3 admin-password to v2.1

This patch changes v3 admin-password API to v2.1 and backport v3
unit test cases to v2.1.
The differences between v2 and v3 are described on the wiki page
https://wiki.openstack.org/wiki/NovaAPIv2tov3

Partially implements blueprint v2-on-v3-api
Change-Id: I167753eddd188120236c51bade549c907c8a8466

2014-08-25 22:09:54 +08:00

api_samples

Merge "Add api extension for new network fields."

2014-08-23 01:50:01 +00:00

ext

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

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

source

Fix class name for ServerGroupAffinityFilter

2014-08-22 20:23:24 +02:00

v3/api_samples

Change v3 admin-password to v2.1

2014-08-25 22:09:54 +08: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