Efficient sphinx

This commit allows us to reduce build time a bit, by reducing the number of network requests it makes for documentation on our lab server.

It also fixes some documentation warnings and introduce a new package: bob.ip.facelandmarks.

build.sh

@@ -19,10 +19,10 @@ basedir=`pwd`
 # Download stock build scripts
 if [ ! -d _ci ]; then
   mkdir _ci
+  curl --silent "https://gitlab.idiap.ch/bob/bob.admin/raw/master/gitlab/install.sh" > ${basedir}/_ci/install.sh
+  chmod 755 ${basedir}/_ci/install.sh
+  ${basedir}/_ci/install.sh _ci
 fi
-curl --silent "https://gitlab.idiap.ch/bob/bob.admin/raw/master/gitlab/install.sh" > ${basedir}/_ci/install.sh
-chmod 755 ${basedir}/_ci/install.sh
-${basedir}/_ci/install.sh _ci
 
 # Defines some required defaults, if they are not set by the CI
 CI_PROJECT_DIR="${CI_PROJECT_DIR:-${basedir}}"
@@ -72,13 +72,19 @@ export_env DOCUSER
 export_env DOCPASS
 export_env PYTHON_VERSION
 
-# Prepares wheel container
-WHEELS_DIR=${basedir}/dist
-if [ ! -d ${WHEELS_DIR} ]; then
-  run_cmd mkdir -pv ${WHEELS_DIR}
-  run_cmd rm -fv ${WHEELS_DIR}/*
+# Prepares dist container
+DIST_DIR=${basedir}/dist
+if [ ! -d ${DIST_DIR} ]; then
+  run_cmd mkdir -pv ${DIST_DIR}
+  run_cmd rm -fv ${DIST_DIR}/*
 fi
 
+# Prefer locally built indexes for documentation to avoid pinging the
+# remote server (faster and more reliable)
+run_cmd mkdir -p ${DIST_DIR}/docs
+BOB_DOCUMENTATION_SERVER="file://${DIST_DIR}/docs/%s/"
+export_env BOB_DOCUMENTATION_SERVER
+
 total=`cat $1 | sed -e '/^\s*#.*/d;/^\s*$/d' | wc -l | xargs echo -n`
 
 log_info "Running builds for all ${total} packages in \`$1'..."
@@ -103,13 +109,13 @@ for f in `cat $1 | sed -e '/^\s*#.*/d;/^\s*$/d'`; do
   CI_PROJECT_DIR=${basedir}/src
   CI_PROJECT_PATH=${CI_PROJECT_NAMESPACE}/${f}
   CI_PROJECT_NAME=${f}
-  WHEELS_REPOSITORY=${WHEELS_DIR}
+  WHEELS_REPOSITORY=${DIST_DIR}
   export_env CI_PROJECT_DIR
   export_env CI_PROJECT_PATH
   export_env CI_PROJECT_NAME
   export_env WHEELS_REPOSITORY
 
-  rm -rf ${CI_PROJECT_DIR}
+  run_cmd rm -rf ${CI_PROJECT_DIR}
   run_cmd git clone --depth 1 ${GITLAB_CHECKOUT_STRATEGY}${CI_PROJECT_PATH} ${CI_PROJECT_DIR}
   run_cmd cd ${CI_PROJECT_DIR}
   run_cmd ln -s ${basedir}/_ci .
@@ -141,6 +147,8 @@ for f in `cat $1 | sed -e '/^\s*#.*/d;/^\s*$/d'`; do
   run_cmd ./_ci/test.sh
 
   # Copies the generated wheel to our provisional wheels repository
-  run_cmd cp -fv dist/*.whl ${WHEELS_DIR}/
+  run_cmd cp -fv dist/*.whl ${DIST_DIR}/
+  # Copies the documentation so it can be subsequently used
+  run_cmd cp -r ${CI_PROJECT_DIR}/sphinx ${DIST_DIR}/docs/${f}
 
 done