openstack/placement
Code Issues Proposed changes
3a919ef79f
placement/doc
History
Pádraig Brady a0dc5a8dd2 fix misspellings in logs, comments and tests 
Flagged with: https://github.com/lyda/misspell-check
Run with: git ls-files | misspellings -f -

Fixes bug: 1100083
Change-Id: Icf1f844fea8ad0a1101d1dc64b9a126608e9536e
2013-01-21 23:14:13 +00:00
..
api_samples/os-aggregates Enable Aggregate based availability zones 2013-01-08 14:00:41 -08:00
source fix misspellings in logs, comments and tests 2013-01-21 23:14:13 +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