nova/doc at eb92d4253650a024e7aa6d37db589cb3cde016e4 - nova

womax/nova

Files

T

Pranav Salunke eb92d42536 Updated Setting up Developer Environment for Ubuntu

I saw that there are a few libraries which are required but not
mentioned in the docs.

Change-Id: I47036bb85c1b4c617f14d7534c204df474439513

2014-03-25 18:13:53 +05:30

api_samples

Add API sample files of "unshelve a server" API

2014-03-19 08:26:40 +09:00

ext

Remove usage of locals() for formatting from nova.api.*

2013-05-18 00:04:17 +04:00

source

Updated Setting up Developer Environment for Ubuntu

2014-03-25 18:13:53 +05:30

v3/api_samples

Merge "Add API sample files of "unshelve a server" API"

2014-03-20 23:17:35 +00:00

README.rst

Replace oslo.sphinx with oslosphinx

2014-02-12 16:45:49 +00:00

README.rst

OpenStack Nova Documentation README
===================================
Included documents:

- developer reference guide(devref)
- man pages

Dependencies
------------
Building this documentation can be done in a regular Nova development
environment, such as the virtualenv created by ``run_tests.sh`` or
``tools/install_venv.py``.  A leaner but sufficient environment can be
created by starting with one that is suitable for running Nova (such
as the one created by DevStack) and then using pip to install
oslosphinx.

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