nova/doc at 2d35c8042d10e936670dcea28bada4d3218f2255 - nova

womax/nova

Files

T

Joe Gordon a4947243d1 Dedup devref on unit tests

We already have a document on how to run unit tests, so
development.environment should just point to that document instead of
trying to summarize it.  Keeping this information in one less places
makes it easier to make sure the page is up to date (which
development.environment is not -- no mention of tox).

Change-Id: I9aecf439b6145b035b3457559ddb187058f5057b

2014-05-04 20:22:07 -07:00

api_samples

Use datetime object for fake network timestamps

2014-04-29 14:51:53 +01:00

ext

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

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

source

Dedup devref on unit tests

2014-05-04 20:22:07 -07:00

v3/api_samples

Merge "Rename instance_actions v3 to server_actions"

2014-04-24 07:18:42 +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