X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fbash%2Ffunction%2Fdocs.sh;h=be3f9861ceade4e1e5d74843db551959882cf20a;hp=ec5cbefdd08007d4060f13c8d37d7478a2f9faaf;hb=aa72d4256fb7409fa01a0cb33aaa763128f0d30b;hpb=c849edfc256df9c3de1ece6babcd4757bb2a8072 diff --git a/resources/libraries/bash/function/docs.sh b/resources/libraries/bash/function/docs.sh index ec5cbefdd0..be3f9861ce 100644 --- a/resources/libraries/bash/function/docs.sh +++ b/resources/libraries/bash/function/docs.sh @@ -50,53 +50,68 @@ function generate_docs () { WORKING_DIR="tmp" BUILD_DIR="_build" + # Remove the old build: + rm -rf ${BUILD_DIR} || true + rm -rf ${WORKING_DIR} || true + # Create working directories - mkdir "${BUILD_DIR}" - mkdir --parents "${WORKING_DIR}"/resources/libraries/python/ - mkdir --parents "${WORKING_DIR}"/resources/libraries/robot/ - mkdir --parents "${WORKING_DIR}"/tests/ + mkdir -p "${BUILD_DIR}" || die "Mkdir failed!" + mkdir -p "${WORKING_DIR}"/resources/libraries/python/ || die "Mkdir failed!" + mkdir -p "${WORKING_DIR}"/resources/libraries/robot/ || die "Mkdir failed!" + mkdir -p "${WORKING_DIR}"/tests/ || die "Mkdir failed!" # Copy the Sphinx source files: - cp -r src/* ${WORKING_DIR}/ + cp -r src/* ${WORKING_DIR}/ || die "Copy the Sphinx source files failed!" # Copy the source files to be processed: - from_dir="../../../resources/libraries/python/" + from_dir="${RESOURCES_DIR}/libraries/python/" to_dir="${WORKING_DIR}/resources/libraries/python/" - command="rsync -a --include '*/'" - ${command} --include '*.py' --exclude '*' "${from_dir}" "${to_dir}" - cp ../../../resources/__init__.py ${WORKING_DIR}/resources/ - cp ../../../resources/libraries/__init__.py ${WORKING_DIR}/resources/libraries/ - from_dir="../../../resources/libraries/robot/" - to_dir="${WORKING_DIR}/resources/libraries/robot/" - ${command} --include '*.robot' --exclude '*' "${from_dir}" "${to_dir}" - from_dir="../../../tests/" - to_dir="${WORKING_DIR}/tests/" - ${command} --include '*.robot' --exclude '*' "${from_dir}" "${to_dir}" + dirs="${from_dir} ${to_dir}" + rsync -ar --include='*/' --include='*.py' --exclude='*' ${dirs} || { + die "rSync failed!" + } - python3 gen_rst.py - # Remove all rst files from ./${WORKING_DIR}/env directory - we do not need - # them - find ./${WORKING_DIR}/env -type f -name '*.rst' | xargs rm -f + from_dir="${RESOURCES_DIR}/libraries/robot/" + to_dir="${WORKING_DIR}/resources/libraries/robot/" + dirs="${from_dir} ${to_dir}" + rsync -ar --include='*/' --include '*.robot' --exclude '*' ${dirs} || { + die "rSync failed!" + } + touch ${to_dir}/index.robot || { + die "Touch index.robot file failed!" + } + + # Due to hoststack tests having dots in the name of suite, tests will become + # disabled as spihnxdoc cannot properly work with the path. gen_rst + # is generating dots scheme. The solution is to rename suites as + # having dots is misleading with robot framework naming conventions. + + #from_dir="${CSIT_DIR}/tests/" + #to_dir="${WORKING_DIR}/tests/" + #dirs="${from_dir} ${to_dir}" + #rsync -ar --include='*/' --include '*.robot' --exclude '*' ${dirs} || { + # die "rSync failed!" + #} + + find ${WORKING_DIR}/ -type d -exec echo {} \; -exec touch {}/__init__.py \; + + python3 gen_rst.py || die "Generate .rst files failed!" # Generate the documentation: - DATE=$(date -u '+%d-%b-%Y') + DATE=$(date -u '+%d-%b-%Y') || die "Get date failed!" all_options=("-v") all_options+=("-c" "${WORKING_DIR}") all_options+=("-a") all_options+=("-b" "html") all_options+=("-E") - all_options+=("-D" "release=$1") - all_options+=("-D" "version='$1 documentation - $DATE'") + all_options+=("-D" "version="${GERRIT_BRANCH:-master}"") all_options+=("${WORKING_DIR}" "${BUILD_DIR}/") set +e sphinx-build "${all_options[@]}" DOCS_EXIT_STATUS="$?" set -e - - find . -type d -name 'env' | xargs rm -rf - } function generate_report () {