#!/bin/bash # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. BUILD_FAIL=0 function setup_directories { language=$1 for directory in ${DIRECTORIES["$language"]} ; do echo " $directory" openstack-generate-docbook -l $language -b $directory -r $DOC_DIR done } function setup_language { language=$1 echo "Setting up files for $language" echo "=======================" echo " Directories:" setup_directories $language if [ -n "$POM_FILE" ] ; then cp $POM_FILE generated/$language/pom.xml fi } function build_rst { language=$1 book=$2 # First build all the single po files # Note that we need to run inside a venv since the venv we are run in # uses SitePackages=True and we have to install Sphinx in the venv # together with openstackdocstheme. With SitePackages, the global Sphinx # is used and that will not work with a local openstackdocstheme installed. if [ ${book} == "user-guide" ] ; then TAG="-t user_only" fi if [ ${book} == "user-guide-admin" ] ; then TAG="-t admin_only" fi tox -evenv "sphinx-build -W -b gettext $TAG doc/${book}/source/ doc/${book}/source/locale/" # Now run msgmerge on all files for f in doc/${book}/source/locale/*.pot ; do # Skip the master file if [ $f == "doc/${book}/source/locale/${book}.pot" ] ; then continue fi bf=$(basename $f) # Remove .pot bfname=${bf%.pot} msgmerge -o doc/${book}/source/locale/${language}/LC_MESSAGES/${bfname}.po \ doc/${book}/source/locale/${language}/LC_MESSAGES/${book}.po \ doc/${book}/source/locale/${bf} msgfmt doc/${book}/source/locale/${language}/LC_MESSAGES/${bfname}.po \ -o doc/${book}/source/locale/${language}/LC_MESSAGES/${bfname}.mo done if [ ${book} == "user-guides" ] ; then tox -evenv "sphinx-build -t user_only -D language=${language} \ doc/${book}/source/ \ doc/${book}/build/html" mkdir -p publish-docs/${language}/user-guide/ rsync -a doc/user-guides/build/html/ publish-docs/${language}/user-guide/ tox -evenv "sphinx-build -t admin_only -D language=${language} \ doc/${book}/source/ \ doc/${book}/build-admin/html" mkdir -p publish-docs/${language}/user-guide-admin/ rsync -a doc/user-guides/build-admin/html/ publish-docs/${language}/user-guide-admin/ else tox -evenv "sphinx-build $TAG -D language=${language} doc/${book}/source/ \ doc/${book}/build/html" mkdir -p publish-docs/${language}/${book}/ rsync -a doc/${book}/build/html/ publish-docs/${language}/${book}/ fi } function test_language { language=$1 echo echo "Building for language $language" echo args=("-v") if [[ $PURPOSE -eq "publish" ]]; then args+=("--publish") fi args+=("--check-build" "-l $language") BUILD_XML=0 for book in ${BOOKS["$language"]}; do if [ ${SPECIAL_BOOKS[$book]+_} ] ; then if [ ${SPECIAL_BOOKS[$book]} == "RST" ] ; then echo "Building translated RST book $book for $language" build_rst $language $book if [[ $? -eq 0 ]] ; then echo "... succeeded" else echo "... failed" BUILD_FAIL=1 fi continue fi fi args+=("--only-book $book") BUILD_XML=1 done if [ "$BUILD_XML" -eq "1" ] ; then setup_language $language openstack-doc-test ${args[@]} if [[ $? -eq 0 ]] ; then echo "... succeeded" else echo "... failed" BUILD_FAIL=1 fi fi } function handle_draft_language { language=$1 echo echo "Moving drafts for language $language" echo mkdir -p publish-docs/draft/$language for book in ${DRAFTS["$language"]}; do case "${book}" in user-guides) mv publish-docs/$language/user-guide publish-docs/draft/$language/user-guide mv publish-docs/$language/user-guide-admin publish-docs/draft/$language/user-guide-admin ;; install-guide|config-reference) mv publish-docs/$language/draft/$book publish-docs/draft/$language/$book # Remove directory if it's empty and do not fail if it's non-empty rmdir publish-docs/$language/draft || true ;; *) mv publish-docs/$language/$book publish-docs/draft/$language/$book ;; esac done } function usage { echo "usage: $0 CONF_FILE PURPOSE LANGUAGE1 LANGUAGE2 ..." echo echo "CONF_FILE is the path to the configuration file." echo echo "PURPOSE is either 'test' or 'publish'." echo echo "LANGUAGE is either 'all' or 'LANG'." echo "LANG is a language code like 'fr' or 'ja'." } # Declare in case it's not in the file declare -A SPECIAL_BOOKS declare -A DRAFTS CONF_FILE=$1 shift if [[ -z $CONF_FILE ]]; then usage exit 1 fi if [[ ! -e $CONF_FILE ]]; then echo "Error: the configuration file '$CONF_FILE' does not exist" exit 1 fi source $CONF_FILE if [[ -z $(declare -p BOOKS 2> /dev/null | grep 'declare -A BOOKS') || \ -z $(declare -p DIRECTORIES 2> /dev/null | grep 'declare -A DIRECTORIES') || \ -z $DOC_DIR ]]; then echo "Error: the configuration file '$CONF_FILE' is invalid" exit 1 fi case "$1" in test|publish) PURPOSE=$1 shift ;; *) usage exit 1 ;; esac for language in "$@" ; do case "$language" in all) for language in "${!BOOKS[@]}"; do test_language $language done # Move draft language guides for language in "${!DRAFTS[@]}"; do handle_draft_language $language done ;; *) if [[ -n ${BOOKS[$language]} ]]; then test_language $language if [ ${DRAFTS["${language}"]+_} ] ; then handle_draft_language $language fi else BUILD_FAIL=1 echo "Error: language $language not handled" fi ;; esac done exit $BUILD_FAIL