openstack/nova
Code Issues Proposed changes
2cbea24209
nova/doc
History
Tracy Jones 2cbea24209 Enable remote debugging for nova 
This patch added 2 command line parameters which are used to
connect to an external debugger such as pycharm or eclipse.
This feature is used when you want to connect to a nova
service via a debugger running on a different host.
To use it you start the nova service with  the following
command line parameters

--remote_debug-host <where the debugger is running>
--remote_debug-port <port> it's listening on>.

DocImpact
Closes-bug: #1251021
Change-Id: I6ede9bf0813eafbeb91d858c297d4c160aafceba
2013-12-16 09:36:33 -08:00
..
api_samples Remove V2 API version of coverage extensions 2013-11-18 22:35:39 +10:30
ext Remove usage of locals() for formatting from nova.api.* 2013-05-18 00:04:17 +04:00
source Enable remote debugging for nova 2013-12-16 09:36:33 -08:00
v3/api_samples Merge "Extends V3 servers api for pci support" 2013-12-11 22:08:53 +00: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