gantt/doc
Mauro S. M. Rodrigues 2f0c8980f5 Add Keypairs extension to API samples test.
NOTE: This include two samples of post request: One to create the keypair and
another to import from a public key

Change-Id: I754fd5998cf8be46a96e69e3459c91d4f767575e
2012-09-18 20:49:59 -04:00
..
api_samples Add Keypairs extension to API samples test. 2012-09-18 20:49:59 -04: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 Fix doc/README.rst to render properly 2012-09-18 11:42:51 -07:00

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