summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRyota MIBU <r-mibu@cq.jp.nec.com>2016-03-16 19:00:56 +0000
committerGerrit Code Review <gerrit@172.30.200.206>2016-03-16 19:00:56 +0000
commitda3bc3668fa4cef4e5f616caf3f35e73df35e3bf (patch)
tree0a36c073a18352d6ec3113e03950c3d1e75a0de6
parent02f30f14f0f0e9abf5600f2059157609db679d65 (diff)
parent604ce38b9998703f4d63d5ac9199a38f78ab53b7 (diff)
Merge "docs: use venv"
-rw-r--r--docs/etc/requirements.txt5
-rwxr-xr-xutils/docs-build.sh16
2 files changed, 17 insertions, 4 deletions
diff --git a/docs/etc/requirements.txt b/docs/etc/requirements.txt
index 4df3b687d..4b1850729 100644
--- a/docs/etc/requirements.txt
+++ b/docs/etc/requirements.txt
@@ -1 +1,6 @@
+Sphinx==1.3.1
+doc8
+docutils
+setuptools
+six
sphinxcontrib-httpdomain
diff --git a/utils/docs-build.sh b/utils/docs-build.sh
index 4d95836d5..48037db2e 100755
--- a/utils/docs-build.sh
+++ b/utils/docs-build.sh
@@ -14,6 +14,7 @@ INDEX_RST=${INDEX_RST:-index.rst}
BUILD_DIR=${BUILD_DIR:-docs_build}
OUTPUT_DIR=${OUTPUT_DIR:-docs_output}
SRC_DIR=${SRC_DIR:-$BUILD_DIR/_src}
+VENV_DIR=${VENV_DIR:-$BUILD_DIR/_venv}
RELENG_DIR=${RELENG_DIR:-releng}
GERRIT_COMMENT=${GERRIT_COMMENT:-}
@@ -48,10 +49,6 @@ opnfv_logo='releng/docs/etc/opnfv-logo.png'
function check_rst_doc() {
_src="$1"
- if ! which doc8 > /dev/null ; then
- echo "Error: 'doc8' not found. Exec 'sudo pip install doc8' first."
- exit 1
- fi
# Note: This check may fail in many jobs for building project docs, since
# the old sample has lines more than 120. We ignore failures on this
# check right now, but these have to be fixed before OPNFV B release.
@@ -140,6 +137,15 @@ fi
prepare_src_files
+if ! which virtualenv > /dev/null ; then
+ echo "Error: 'virtualenv' not found. Exec 'sudo pip install virtualenv' first."
+ exit 1
+fi
+
+virtualenv "$VENV_DIR"
+source "$VENV_DIR/bin/activate"
+pip install -r "$RELENG_DIR/docs/etc/requirements.txt"
+
find $DOCS_DIR -name $INDEX_RST -printf '%h\n' | while read dir
do
name=$(generate_name $dir)
@@ -224,3 +230,5 @@ do
fi
done
+
+deactivate