x/gantt
Code Issues Proposed changes
Files
222182b0c57be6120c609697b0494d9cb0e204b0
gantt/doc
History
Doug Hellmann 222182b0c5 Fix formatting errors in documentation 
Fix a few rst formatting errors in the docs so
sphinx does not generate warnings.

Change-Id: I000d2ca3961678b47ead7a7885f3bc88ed7babc7
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
2013-07-06 13:18:11 -04:00
..
api_samples
Sane rest API rate limit defaults
2013-06-27 16:00:58 -07:00
ext
Remove usage of locals() for formatting from nova.api.*
2013-05-18 00:04:17 +04:00
source
Fix formatting errors in documentation
2013-07-06 13:18:11 -04:00
README.rst
Fix inaccuracies in the development environment doc.
2013-02-11 09:29:48 -06:00

README.rst

OpenStack Nova Documentation README

Included documents:

  • developer reference guide(devref)
  • man pages

Building the docs

From the root nova directory:

python setup.py build_sphinx

Building just the man pages

from the root nova directory:

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-scheduler:

mkdir /usr/local/man/man1
install -g 0 -o 0 -m 0644 doc/build/man/nova-scheduler.1  /usr/local/man/man1/nova-scheduler.1
gzip /usr/local/man/man1/nova-scheduler.1
man nova-scheduler