nova/doc at 694bcb7f7c1e44ac875ce658debe3d0505e45706 - nova

womax/nova

Files

T

Sulochan Acharya 694bcb7f7c Update command on devref doc

Update the apt-get command to build mysql dependency for ubuntu.
It currenly says apt-get install build-dep python-mysqldb
which should just be apt-get build-dep python-mysqldb

Change-Id: I541f7b80802a6b7191f2fe0338965ef425e7c2fd

2012-12-14 11:40:22 -06:00

api_samples

Fix errors in used_limits extension

2012-12-13 16:46:44 +00:00

ext

Fix PEP8 issues.

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

source

Update command on devref doc

2012-12-14 11:40:22 -06: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