ed100316b4
We do not need the DocBook XML glossary anymore, since we do not build any DocBook guides that use it. Add instead the RST version of the document to git. Adjust scripts to not build or publish the glossary anymore. Change-Id: Id4bfef7666690e6d08291f664751db7a4d4d5983
96 lines
2.3 KiB
Bash
Executable File
96 lines
2.3 KiB
Bash
Executable File
#!/bin/bash -e
|
|
#
|
|
# 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.
|
|
|
|
DIRECTORY=$1
|
|
|
|
if [ -z "$DIRECTORY" ] ; then
|
|
echo "usage $0 DIRECTORY options"
|
|
echo "Options are:"
|
|
echo "--tag TAG: Use given tag for building"
|
|
echo "--target TARGET: Copy files to publish-docs/$TARGET"
|
|
echo "--build BUILD: Name of build directory"
|
|
echo "--linkcheck: Check validity of links instead of building"
|
|
exit 1
|
|
fi
|
|
|
|
TARGET=""
|
|
TAG=""
|
|
TAG_OPT=""
|
|
BUILD=""
|
|
LINKCHECK=""
|
|
|
|
while [[ $# > 0 ]] ; do
|
|
option="$1"
|
|
case $option in
|
|
--build)
|
|
BUILD="$2"
|
|
shift
|
|
;;
|
|
--linkcheck)
|
|
LINKCHECK=1
|
|
;;
|
|
--tag)
|
|
TAG="$2"
|
|
TAG_OPT="-t $2"
|
|
shift
|
|
;;
|
|
--target)
|
|
TARGET="$2"
|
|
shift
|
|
;;
|
|
esac
|
|
shift
|
|
done
|
|
|
|
|
|
if [ -z "$BUILD" ] ; then
|
|
if [ -z "$TAG" ] ; then
|
|
BUILD_DIR="$DIRECTORY/build/html"
|
|
else
|
|
BUILD_DIR="$DIRECTORY/build-${TAG}/html"
|
|
fi
|
|
else
|
|
BUILD_DIR="$DIRECTORY/$BUILD/html"
|
|
fi
|
|
|
|
DOCTREES="${BUILD_DIR}.doctrees"
|
|
|
|
if [ -z "$TAG" ] ; then
|
|
echo "Checking $DIRECTORY..."
|
|
else
|
|
echo "Checking $DIRECTORY with tag $TAG..."
|
|
fi
|
|
|
|
if [ "$LINKCHECK" = "1" ] ; then
|
|
# Show sphinx-build invocation for easy reproduction
|
|
set -x
|
|
sphinx-build -E -W -d $DOCTREES -b linkcheck \
|
|
$TAG_OPT $DIRECTORY/source $BUILD_DIR
|
|
set +x
|
|
else
|
|
# Show sphinx-build invocation for easy reproduction
|
|
set -x
|
|
sphinx-build -E -W -d $DOCTREES -b html \
|
|
$TAG_OPT $DIRECTORY/source $BUILD_DIR
|
|
set +x
|
|
|
|
# Copy RST
|
|
if [ "$TARGET" != "" ] ; then
|
|
mkdir -p publish-docs/$TARGET
|
|
rsync -a $BUILD_DIR/ publish-docs/$TARGET/
|
|
# Remove unneeded build artefact
|
|
rm -f publish-docs/$TARGET/.buildinfo
|
|
fi
|
|
fi
|