a09598585f
Add all files for RST conversion of security-guide. The guide will be published to docs.openstack.org/draft/security-guide-rst while conversion happens. Translations are currently disabled for this guide during the conversion. Add tooling so that the guide gets build automatically. Add initial content. Note that the files in the imported directory will be imported from openstack-manuals automatically once this change is in, they are stubs right now to have this building. Change-Id: Id5fc16d3a3c8e2efa98eb3fd7f5c986e0a83a76b
79 lines
1.8 KiB
Bash
Executable File
79 lines
1.8 KiB
Bash
Executable File
#!/bin/bash -xe
|
|
#
|
|
# 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 "--glossary: Build glossary"
|
|
echo "--tag TAG: Use given tag for building"
|
|
echo "--target TARGET: Copy files to publish-docs/$TARGET"
|
|
echo "--build BUILD: Name of build directory"
|
|
exit 1
|
|
fi
|
|
|
|
GLOSSARY=0
|
|
TARGET=""
|
|
TAG=""
|
|
TAG_OPT=""
|
|
BUILD=""
|
|
|
|
while [[ $# > 1 ]] ; do
|
|
option="$1"
|
|
case $option in
|
|
--glossary)
|
|
GLOSSARY=1
|
|
;;
|
|
--tag)
|
|
TAG="$2"
|
|
TAG_OPT="-t $2"
|
|
shift
|
|
;;
|
|
--target)
|
|
TARGET="$2"
|
|
shift
|
|
;;
|
|
--build)
|
|
BUILD="$2"
|
|
shift
|
|
;;
|
|
esac
|
|
shift
|
|
done
|
|
|
|
|
|
if [ "$GLOSSARY" -eq "1" ] ; then
|
|
echo "Generating Glossary"
|
|
tools/glossary2rst.py doc/common-rst/glossary.rst
|
|
fi
|
|
|
|
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
|
|
|
|
sphinx-build -E -W $TAG_OPT $DIRECTORY/source $BUILD_DIR
|
|
|
|
# Copy RST
|
|
if [ "$TARGET" != "" ] ; then
|
|
mkdir -p publish-docs/$TARGET
|
|
rsync -a $BUILD_DIR/ publish-docs/$TARGET/
|
|
fi
|