d3b0cd4827
Because of known issues with Sphinx/Breathe tools we're using to generate doxygen-based comments for our API documentation, we're getting a bevy of warning messages written out. As a workaround for our CI system, we created a filter-known-issues.py script to remove "expected" warnings from the output. This patch moves calling that filter script into the doc generation Makefile so folks making local builds of the docs won't be tripped up by all the warning messages either. Output of the "make htmldocs" command is now filtered so only "unexpected" errors and warnings will be shown. (See https://github.com/sphinx-doc/sphinx/issue/2682 and sphinx-doc/sphinx#2683i for the Sphinx/Breathe issues.) Fixes #1527 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
27 lines
674 B
Bash
Executable File
27 lines
674 B
Bash
Executable File
#!/bin/bash
|
|
|
|
# run the filter-known-issues.py script to remove "expected" warning
|
|
# messages from the output of the document build process and write
|
|
# the filtered output to stdout
|
|
#
|
|
# Only argument is the name of the log file saved by the build.
|
|
|
|
KI_SCRIPT=${ZEPHYR_BASE}/scripts/filter-known-issues.py
|
|
CONFIG_DIR=${ZEPHYR_BASE}/.known-issues/doc
|
|
|
|
LOG_FILE=$1
|
|
|
|
if [ -z "${LOG_FILE}" ]; then
|
|
echo "Error in $0: missing input parameter <logfile>"
|
|
exit 1
|
|
fi
|
|
|
|
if [ -e "${LOG_FILE}" ]; then
|
|
if [ -s "${LOG_FILE}" ]; then
|
|
$KI_SCRIPT --config-dir ${CONFIG_DIR} ${LOG_FILE}
|
|
fi
|
|
else
|
|
echo "Error in $0: logfile \"${LOG_FILE}\" not found."
|
|
exit 1
|
|
fi
|