240 lines
7.2 KiB
Bash
Executable File
240 lines
7.2 KiB
Bash
Executable File
#!/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.
|
|
TAG=""
|
|
# We need to extract all strings, so add all supported tags
|
|
if [ ${book} = "firstapp" ] ; then
|
|
TAG="-t libcloud -t fog"
|
|
fi
|
|
tox -evenv "sphinx-build -W -b gettext $TAG ${DOC_DIR}${book}/source/ ${DOC_DIR}${book}/source/locale/"
|
|
# Merge the common-rst po file in
|
|
if [[ -e ${DOC_DIR}common-rst/source/locale/${language}/LC_MESSAGES/common-rst.po ]] ; then
|
|
msgcat --use-first -o ${DOC_DIR}${book}/source/locale/${language}/${book}.po \
|
|
${DOC_DIR}${book}/source/locale/${language}/LC_MESSAGES/${book}.po \
|
|
${DOC_DIR}common-rst/source/locale/${language}/LC_MESSAGES/common-rst.po
|
|
mv -f ${DOC_DIR}${book}/source/locale/${language}/${book}.po \
|
|
${DOC_DIR}${book}/source/locale/${language}/LC_MESSAGES/${book}.po
|
|
fi
|
|
# Now run msgmerge on all files
|
|
for f in ${DOC_DIR}${book}/source/locale/*.pot ; do
|
|
# Skip the master file
|
|
if [ $f = "${DOC_DIR}${book}/source/locale/${book}.pot" ] ; then
|
|
continue
|
|
fi
|
|
bf=$(basename $f)
|
|
# Remove .pot
|
|
bfname=${bf%.pot}
|
|
msgmerge -o ${DOC_DIR}${book}/source/locale/${language}/LC_MESSAGES/${bfname}.po \
|
|
${DOC_DIR}${book}/source/locale/${language}/LC_MESSAGES/${book}.po \
|
|
${DOC_DIR}${book}/source/locale/${bf}
|
|
msgfmt ${DOC_DIR}${book}/source/locale/${language}/LC_MESSAGES/${bfname}.po \
|
|
-o ${DOC_DIR}${book}/source/locale/${language}/LC_MESSAGES/${bfname}.mo
|
|
done
|
|
if [ ${book} = "firstapp" ] ; then
|
|
tox -evenv "sphinx-build -t fog -D language=${language} \
|
|
${DOC_DIR}${book}/source/ \
|
|
${DOC_DIR}${book}/build-fog/html"
|
|
mkdir -p publish-docs/${language}/firstapp-fog
|
|
rsync -a ${DOC_DIR}firstapp/build-fog/html/ publish-docs/${language}/firstapp-fog
|
|
tox -evenv "sphinx-build -t libcloud -D language=${language} \
|
|
${DOC_DIR}${book}/source/ \
|
|
${DOC_DIR}${book}/build-libcloud/html"
|
|
mkdir -p publish-docs/${language}/firstapp-libcloud
|
|
rsync -a ${DOC_DIR}user-guides/build-libcloud/html/ publish-docs/${language}/firstapp-libcloud/
|
|
else
|
|
tox -evenv "sphinx-build -D language=${language} ${DOC_DIR}${book}/source/ \
|
|
${DOC_DIR}${book}/build/html"
|
|
mkdir -p publish-docs/${language}/${book}/
|
|
rsync -a ${DOC_DIR}${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
|
|
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
|