nova/doc at 40bf0ab3e6580c4cf66ea7d7dd6db599d498b554 - nova

womax/nova

Files

T

Matt Riedemann 40bf0ab3e6 Remove mention of nova-manage.conf from nova-manage.rst

As of commit 07ee9639 three years ago nova-manage.conf is no longer
used, so let's clean up the man page.

Closes-Bug: #1304580

Change-Id: Ie061733da4bd0337f510e17b6dd7ca5bae14b7de

2014-04-08 12:05:16 -07:00

api_samples

Correct the keypairs-get-resp.json API sample file

2014-04-01 08:57:06 +09:00

ext

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

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

source

Remove mention of nova-manage.conf from nova-manage.rst

2014-04-08 12:05:16 -07:00

v3/api_samples

Correct the keypairs-get-resp.json API sample file

2014-04-01 08:57:06 +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