openstack/nova
Code Issues Proposed changes
8af6c6b885
nova/doc
History
Giampaolo Lauria adbfd0da94 Added sample tests to floating-ip-pools API. 
Partially implements blueprint nova-api-samples
Fixes bug 1070165

Change-Id: Ia7d99354ae815cdd8a41b012f568877751a3d8bd
2013-01-23 17:53:31 -05:00
..
api_samples Added sample tests to floating-ip-pools API. 2013-01-23 17:53:31 -05:00
ext Fix PEP8 issues. 2012-08-28 23:13:11 +08:00
source fix misspellings in logs, comments and tests 2013-01-21 23:14:13 +00:00
README.rst Fix doc/README.rst to render properly 2012-09-18 11:42:51 -07:00

README.rst

OpenStack Nova Documentation README

Included documents:

  • developer reference guide(devref)
  • man pages

Building the docs

From the root nova director:

python setup.py build_sphinx

Building just the man pages

from the root nova director:

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-manage:

mkdir /usr/local/man/man1
install -g 0 -o 0 -m 0644 doc/build/man/nova-manage.1  /usr/local/man/man1/nova-manage.1
gzip /usr/local/man/man1/nova-manage.1
man nova-manage