nova/doc at 04f8dcf0bdac9d3e7f75dfb91d492887bf6e4a25 - nova

womax/nova

Files

T

ladquin 04f8dcf0bd Fix for typo in xml API doc sample in nova

Modified:   doc/api_samples/os-flavor-manage/flavor-create-post-req.json
Deleted final comma for proper syntax
Partially fixes: bug 1088528 (part of the bug requires changes in other repo - done)

Change-Id: I5b0b29b4c720a95d5c4c5d957e77dc2e4c9cf8ee

2013-01-22 13:36:49 -03:00

api_samples

Fix for typo in xml API doc sample in nova

2013-01-22 13:36:49 -03:00

ext

Fix PEP8 issues.

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

source

Merge "Add nova-spicehtml5proxy helper"

2013-01-17 11:59:25 +00: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