# Note: This check may fail in many jobs for building project docs, since
# the old sample has lines more than 120. We ignore failures on this
# check right now, but these have to be fixed before OPNFV B release.
- _out=$(doc8 --max-line-length 120 "$_src") || {
+ _out=$(doc8 --max-line-length 120 --ignore D000 "$_src") || {
_msg='Error: rst validatino (doc8) has failed, please fix the following error(s).'
_errs=$(echo "$_out" | sed -n -e "/^$_src/s/^/ /p")
echo
function add_html_notes() {
_src="$1"
- _dir="$2"
- if grep -q -e ' _sha1_' "$_src"/*.rst ; then
- # TODO: remove this, once old templates were removed from all repos.
- echo
- echo "Warn: '_sha1_' was found in $_dir , use the latest document template."
- echo " See https://wiki.opnfv.org/documentation/tools ."
- echo
- sed -i "s/ _sha1_/ $git_sha1/g" "$_src"/*.rst
- fi
- sed -i -e "\$a\\\n.. only:: html\n$html_notes" "$_src"/*.rst
+ find "$_src" -name '*.rst' | while read file
+ do
+ if grep -q -e ' _sha1_' "$file" ; then
+ # TODO: remove this, once old templates were removed from all repos.
+ echo
+ echo "Warn: '_sha1_' was found in [$file], use the latest document template."
+ echo " See https://wiki.opnfv.org/documentation/tools ."
+ echo
+ sed -i "s/ _sha1_/ $git_sha1/g" "$file"
+ fi
+ sed -i -e "\$a\\\n.. only:: html\n$html_notes" "$file"
+ done
+}
+
+function prepare_src_files() {
+ mkdir -p "$BUILD_DIR"
+ [[ -e "$BUILD_DIR/src" ]] && rm -rf "$BUILD_DIR/src"
+ cp -r "$SRC_DIR" "$BUILD_DIR/src"
+ add_html_notes "$BUILD_DIR/src"
}
function add_config() {
echo "${_name////_}"
}
+
check_rst_doc $SRC_DIR
if [[ ! -d "$RELENG_DIR" ]] ; then
exit 1
fi
+prepare_src_files
+
find $SRC_DIR -name $INDEX_RST -printf '%h\n' | while read dir
do
name=$(generate_name $dir)
- src="$BUILD_DIR/src/$name"
+ src="$BUILD_DIR/src${dir#$SRC_DIR}"
build="$BUILD_DIR/$name"
output="$OUTPUT_DIR/$name"
conf="$src/conf.py"
echo "#################${dir//?/#}"
echo
- mkdir -p "$BUILD_DIR/src"
- [[ -e "$src" ]] && rm -rf "$src"
- cp -r "$dir" "$src"
-
- add_html_notes "$src" "$dir"
-
[[ ! -f "$conf" ]] && cp "$default_conf" "$conf"
title=$(cd $src; python -c "$get_title_script")
latex_conf="[('index', '$name.tex', \"$title\", 'OPNFV', 'manual'),]"