From 27c8713840d905185e22e8af44cea340921f1cb2 Mon Sep 17 00:00:00 2001 From: Mike Spreitzer Date: Tue, 7 Jan 2014 02:47:28 -0500 Subject: [PATCH] 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 --- doc/README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/README.rst b/doc/README.rst index 4134284514d5..92db83b49b67 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 -----------------