nova/doc at 352eac12e3126089eef80fbe16a2b0874662c12f - nova

womax/nova

Files

T

Joe Gordon 352eac12e3 Update nova-cert man page

nova-cert is:
* Used to generate certificates for euca-bundle-image.
* Only needed for EC2 API.

Change-Id: If941e964d152a9af5980a2589bc0f0f8ee4842b7

2012-12-27 17:57:12 -08:00

api_samples

Add extension to allow hiding of addresses

2012-12-20 15:43:15 -06:00

ext

Fix PEP8 issues.

2012-08-28 23:13:11 +08:00

source

Update nova-cert man page

2012-12-27 17:57:12 -08: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