openstack/nova
Code Issues Proposed changes
b5d242b209
nova/doc/README.rst
Joe Gordon fba9f7666d Fix doc/README.rst to render properly 
Fix doc/README.rst to work on github:
https://github.com/openstack/nova/tree/master/doc

Change-Id: Ib589607014158c2a5af26bd137e252e5a0de30c6
2012-09-18 11:42:51 -07:00

781 B
Raw Blame History

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