Files
nova/doc
Matthew Treinish ce2ba8fae8 Add aggregates extension to API samples test.
Change-Id: I8f0f5b022795dc1d766e585cab8fe5f8445a3722
Signed-off-by: Matthew Treinish <treinish@linux.vnet.ibm.com>
2012-10-01 14:51:04 -04:00
..
2012-08-28 23:13:11 +08: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