openstack/nova

History

pmoosh 73b82dda9d Updates the documentation for nova unit tests unit_tests.rst is outdated and does not reflect the recent changes in the run_tests.sh script. Fix required an update of the usage output of run_tests.sh as well as changes to some references. Nova now uses testrepository and flake8. There were also changes to the examples shown in the section "Running a subset of tests". All the updated examples were tested. Removes white spaces at the of end 3 lines. Change-Id: I3fa040d5682ad94d861cef2a64b19b4da947318b Closes-Bug: #1219040		2013-10-25 11:45:04 -07:00
..
api_samples	Expose additional status in baremetal API extension	2013-10-22 03:58:43 +00:00
ext	Remove usage of locals() for formatting from nova.api.*	2013-05-18 00:04:17 +04:00
source	Updates the documentation for nova unit tests	2013-10-25 11:45:04 -07:00
v3/api_samples	Merge "Adds V3 API samples for console output"	2013-10-23 07:50:39 +00:00
README.rst	Fix inaccuracies in the development environment doc.	2013-02-11 09:29:48 -06:00

README.rst

OpenStack Nova Documentation README

Included documents:

developer reference guide(devref)
man pages

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