History

Davanum Srinivas a507d42cf5 docs - Set pbr 'warnerrors' option for doc build

By setting this pbr option in setup.cfg, the doc build will fail in case
of any warnings or errors occur during the build process.

Closes-Bug: #1351350

Change-Id: Id4858062d2aaa4c2fe5b597e40e4e8947f544a4d

2014-08-11 12:53:37 +00:00

api_samples

Merge "servers list API support specify multi-status"

2014-08-07 06:48:05 +00:00

ext

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

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

source

docs - Set pbr 'warnerrors' option for doc build

2014-08-11 12:53:37 +00:00

v3/api_samples

Return status for compute node

2014-07-22 10:44:05 -07: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