Skip to content

Commit 9fd5ac5

Browse files
author
Daniel Schlaepfer
committed
Update tools/run_doxygen.sh script: warn if bibtex is missing
- bibtex is required to parse "\cite" commands in the documentation and build a bibliography - if bibtex is missing, then doxygen still creates a working documentation * however, the documentation will be without citations and without a bibliography * warnings are issued and the script signals an error
1 parent cd3a1b3 commit 9fd5ac5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

tools/run_doxygen.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ log=${doc_path}"/log_doxygen.log" # logfile for doxygen output
1818
log_tmp=${doc_path}"/log_doxygen_tmp.log"
1919
doxexcept=${doc_path}"/doxygen_exceptions.txt" # filename that lists exceptions (one per line)
2020

21+
# Warn if bibtex is not available
22+
# bibtex is required to resolve `\cite` and build bibliography
23+
if ! type -P bibtex &> /dev/null; then
24+
echo "bibtex is not available but required to build bibliography."
25+
# exit 1
26+
fi
27+
2128
# Downgrade/upgrade Doxyfile in case this runs an different doxygen version, e.g.,
2229
# travis-ci is currently on 1.8.11
2330
#if [[ $(doxygen --version) != "1.8.17" ]]; then

0 commit comments

Comments
 (0)