History

Sean Dague 5fca1d9e97 fix new N402 errors

fix the N402 errors that have slipped in in the last 48 hrs since
starting this patch series.

fix an N401 error that our scanner current can't find because it
only looks for doc strings on classes and defs.

this is the xeno's paradox of patch series, but we're getting close.

Change-Id: I4a763bb4c812335d853eae05c72464f18ab93297

2013-01-10 08:57:09 -05:00

api_samples

fix new N402 errors

2013-01-10 08:57:09 -05:00

ext

Fix PEP8 issues.

2012-08-28 23:13:11 +08:00

source

CLI for bare-metal database sync.

2013-01-08 22:56:14 +09:00

README.rst

Fix doc/README.rst to render properly

2012-09-18 11:42:51 -07:00

README.rst

OpenStack Nova Documentation README

Included documents:

developer reference guide(devref)
man pages

Building the docs

From the root nova director:

python setup.py build_sphinx

Building just the man pages

from the root nova director:

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

mkdir /usr/local/man/man1
install -g 0 -o 0 -m 0644 doc/build/man/nova-manage.1  /usr/local/man/man1/nova-manage.1
gzip /usr/local/man/man1/nova-manage.1
man nova-manage