nova/doc at 8d4af6b906e70437fa77e7cdc5b0e2fcd216c17d - nova

womax/nova

Files

T

Sean Dague 8d4af6b906 all_extensions api_samples testing for server actions

server actions sometimes return servers objects, which means
their output is different when extensions are enabled. This
adds api samples for those cases to give a more realistic view
to the user of what they might expect.

Change-Id: Iaa9a4c3a373dee41931c5dc4f1b805f09a05299f

2012-09-25 10:15:27 -04:00

api_samples

all_extensions api_samples testing for server actions

2012-09-25 10:15:27 -04:00

ext

Fix PEP8 issues.

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

source

Remove refs to ATAoE from nova docs

2012-09-23 14:12:42 +10: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