Files

Daniel P. Berrange 977f4e0f5a Clarify & fix docs for nova-novncproxy

Clarify docs for nova-novncproxy to indicate that it only serves
noVNC web content. Also remove duplicated link from manpage

Change-Id: Ia1f4aff21591132a5c41810a371d248ea0001e1f

2013-01-03 11:01:33 +00:00

api_samples

Merge "Add API sample tests to FixedIPs extension"

2013-01-02 14:29:25 +00:00

ext

Fix PEP8 issues.

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

source

Clarify & fix docs for nova-novncproxy

2013-01-03 11:01:33 +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