nova/doc at aeda1f6e64f77cd8e54b434be8083f5f6e66237c - nova

womax/nova

Files

T

Debo Dutta aeda1f6e64 Add REST API for instance group api extension

Support the Creation, Read, Delete, and List of server groups.

Refactored the code to use objects (https://review.openstack.org/#/c/38979/
Renamed from "instance group" to "server group".

Implements: blueprint instance-group-api-extension

Change-Id: I650a8f191dea5eab5b4b1828f0b9f65e33edea2a

2014-03-06 23:30:44 -08:00

api_samples

Add REST API for instance group api extension

2014-03-06 23:30:44 -08:00

ext

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

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

source

Fix development environment docs for redhat-based systems

2014-03-05 16:12:11 -08:00

v3/api_samples

Add os-server-external-events V3 API

2014-03-06 07:40:43 -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