Sean Dague b349340e6e update api_samples add os-server-start-stop
api_samples docs for os-server-start-stop apparently got
lost in adding the extension api_samples tests. Adding
in the docs for the extension

DocImpact

Change-Id: Ia9b97c0eb4fc7e8b22fe624ccddab6c7e003952e
2012-11-16 10:32:12 -05: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