nova/doc
Jenkins baf5e03f1c Merge "Add man pages" 2012-09-18 00:18:47 +00:00
..
api_samples Merge "Includes sec group quota details in limits API response" 2012-09-17 22:42:40 +00:00
ext Fix PEP8 issues. 2012-08-28 23:13:11 +08:00
source Add man pages 2012-09-17 12:00:08 -07:00
README.rst Add README for doc folder 2012-09-13 17:39:30 -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