openstack/nova

History

Jenkins 9ebcd1d91c Merge "correcting for proper use of the word 'an'."		2013-01-21 22:58:28 +00:00
..
api_samples	Expose a get_spice_console RPC API method	2013-01-16 10:19:37 +00:00
ext	Fix PEP8 issues.	2012-08-28 23:13:11 +08:00
source	Merge "correcting for proper use of the word 'an'."	2013-01-21 22:58:28 +00: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