openstack/nova

History

Joe Gordon 29f7bdc045 Remove nova-volume DB * Remove volume calls from nova.db.api * Remove volume calls from nova.db.sqlalchemy.api * Remove tables from nova/db/sqlalchemy/models.py * Remove Xen Storage Manager Volume Driver code * No migration to preserve data in unused tables * Remove quota support for volumes DocImpact part of bp delete-nova-volume Change-Id: I2c82c96d67f3746e5de28f917dd8ceb0c8037e27		2012-11-08 21:31:31 +00:00
..
api_samples	Remove nova-volume DB	2012-11-08 21:31:31 +00:00
ext	Fix PEP8 issues.	2012-08-28 23:13:11 +08:00
source	Remove nova-volume scheduling support	2012-10-31 23:10:11 +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