nova/doc
Arata Notsu 415b51bf71 baremetal: Drop unused columns in bm_nodes
Drop these two columns:
* bm_nodes.prov_vlan_id
* bm_nodes.registration_status

And update related code, tests and api_samples.

Change-Id: Iadefc83a00ad9ae5a3bb39f357080299875bdf09
2013-04-02 11:08:41 +09:00
..
api_samples baremetal: Drop unused columns in bm_nodes 2013-04-02 11:08:41 +09:00
ext Fix PEP8 issues. 2012-08-28 23:13:11 +08:00
source Remove gettext.install() from nova/__init__.py 2013-04-01 13:44:47 -04: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