openstack/nova
Code Issues Proposed changes
Files
797e9dc50f4e0a326e508ebddeb07b6b3721c8dc
nova/doc
History
Giampaolo Lauria 797e9dc50f Added sample tests to FlavorManage API. 
Partially implements blueprint nova-api-samples
Fixes bug 1070163

Change-Id: Ib838adf0c21f3eee6c52cd8e1942c96ae89cca98
2012-12-08 14:11:15 -05:00
..
api_samples
Added sample tests to FlavorManage API.
2012-12-08 14:11:15 -05:00
ext
Fix PEP8 issues.
2012-08-28 23:13:11 +08:00
source
Merge "Enhance compute capability filter to check multi-level"
2012-11-20 01:05:56 +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