diff options
| author | Mike Spreitzer <mspreitz@us.ibm.com> | 2014-01-07 02:47:28 -0500 |
|---|---|---|
| committer | Mike Spreitzer <mspreitz@us.ibm.com> | 2014-01-20 23:07:34 -0500 |
| commit | 27c8713840d905185e22e8af44cea340921f1cb2 (patch) | |
| tree | f23a9fc5ab1a87a97e5aeb3d9b6353e92302ea5c /doc/README.rst | |
| parent | 23a0bea232b42df3c26425d7164c779c82fa7a77 (diff) | |
| download | nova-27c8713840d905185e22e8af44cea340921f1cb2.tar.gz | |
Add explicit discussion of dependencies to README.rst
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
Diffstat (limited to 'doc/README.rst')
| -rw-r--r-- | doc/README.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/README.rst b/doc/README.rst index 4134284514..92db83b49b 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -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 ----------------- |