openstack/placement
Code Issues Proposed changes

Work on document structure and doc building

Browse Source 
This patch clarifies the document structure of
doc/source/devref/development.environment.rst and adds a section about
how to build the documentation.  This patch also strips out the
redundant information in doc/README.rst, replacing it with a reference
to doc/source/devref/development.environment.rst.

Change-Id: Ia354dcbaea35b812327dac7371ea2fe9aec2b594
Closes-Bug: 1268424
This commit is contained in:
Mike Spreitzer 2014-07-24 14:46:15 -04:00
parent 5d6ab172ab
commit 5438a69e98
1 changed files with 2 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
doc/README.rst
View File

@ -1,40 +1,5 @@
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
See the "Building the Documentation" section of
doc/source/devref/development.environment.rst.