openstack/nova
Code Issues Proposed changes
864681ee27
nova/doc
History
He Jie Xu d61d1f62da Enable extension access_ips for v3 API 
This patch enable extension access_ips, remove old 'access_ip_*'
attributes and related unittest from servers core. And remove
old attributes from api samples.

Partially implements bp nova-v3-api

DocImpact

Change-Id: Id4c8bb721550e317e0695d7876e2faa3d6e91a60
2013-10-26 17:19:46 +08: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 Enable extension access_ips for v3 API 2013-10-26 17:19:46 +08: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