openstack/nova
Code Issues Proposed changes
505af894f3
nova/doc
History
Russell Bryant 56f5172f33 Revert "Include list of attached volumes with instance info" 
This reverts commit dd66f235ec.

This changed the core servers API without doing it as an API extension,
so it's not an acceptable change as written.

Change-Id: I3787060583de1371e366647d38d69f37746317d5
2013-05-15 20:10:00 -04:00
..
api_samples Revert "Include list of attached volumes with instance info" 2013-05-15 20:10:00 -04:00
ext Fix PEP8 issues. 2012-08-28 23:13:11 +08:00
source Add NOVA_LOCALEDIR env variable 2013-04-10 10:24:27 +01: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