nova/doc at 3edfac2e8663886fe2b3b13e0bec63126bd2a4cb - nova

womax/nova

Files

T

Ghanshyam 3edfac2e86 Convert v3 server diagnostics plugin to v2.1

This patch changes v3 server diagnostics plugin to v2.1 and makes v2
unit tests share between v2 and v2.1.

This patch also delete the V3 server_diagnostics API tests.

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: If10615f3f119dda815d56cf8329619bab502e091

2014-08-27 16:19:17 +09: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

filter: add per-aggregate filter to configure disk_allocation_ratio

2014-08-26 12:56:51 +00:00

v3/api_samples

Convert v3 server diagnostics plugin to v2.1

2014-08-27 16:19:17 +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