openstack/placement
Code Issues Proposed changes

Add explicit discussion of dependencies to README.rst

Browse Source 
Noted that building the documentation has more dependencies
than merely running Nova.
Noted that the standard development environment is sufficient.
Noted that the standard runtime environment plus oslo.sphinx
is sufficient.

Change-Id: I37b84a1bdfbc906b005c0a53c2c570c0695937b3
Closes-Bug: #1266623
This commit is contained in:
Mike Spreitzer
2014-01-07 02:47:28 -05:00
parent 63f33b6624
commit 3d32c32774
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/README.rst
View File

@@ -5,6 +5,14 @@ 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
oslo.sphinx.
Building the docs
-----------------