History

Matt Riedemann 4c6b0f71c2 Revert "Remove broken quota-classes API" This reverts commit `7d22153d05`. The quota_classes API was used to set default quota values so it shouldn't have been removed, so reverting a series of changes that removed the API and it's internal code. Related mailing list thread on the topic: http://lists.openstack.org/pipermail/openstack-dev/2014-May/035383.html Partial-Bug: #1299517 Conflicts: doc/api_samples/all_extensions/extensions-get-resp.json doc/api_samples/all_extensions/extensions-get-resp.xml nova/tests/integrated/api_samples/all_extensions/extensions-get-resp.xml.tpl The conflicts are due to Mark McLoughlin's timestamp-format series of changes on master (Juno). Also note that quota_classes.py was changed due to commit `c75a15a4` to rename the NotAuthorized exception to Forbidden. Change-Id: I7890e6b41d4ebf19944c1d4db65111fcc4c45463 (cherry picked from commit `35338d54ad`)		2014-06-10 13:13:25 -07:00
..
api_samples	Revert "Remove broken quota-classes API"	2014-06-10 13:13:25 -07:00
ext	Remove usage of locals() for formatting from nova.api.*	2013-05-18 00:04:17 +04:00
source	Update docs to reflect new default filters	2014-04-08 17:41:33 -04:00
v3/api_samples	Merge "Add API sample files of "unshelve a server" API"	2014-03-20 23:17:35 +00: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