Skip to content

Commit 43c95c6

Browse files
committed
Moved documentation creation to a separate step and no longer hide errors.
1 parent 8bd045d commit 43c95c6

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

.github/workflows/doc-check.yml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,19 +45,22 @@ jobs:
4545
- name: Install Doxygen
4646
run: sudo apt-get update && sudo apt-get install -y doxygen
4747

48+
- name: Generate Magick++ documentation
49+
run: |
50+
# Magick++.dox.in is an autoconf template; substitute the placeholders normally filled in by `configure`
51+
cd ImageMagick/config
52+
sed -e 's/@srcdir@/./g' -e 's/@PACKAGE_VERSION@/0.0.0/g' Magick++.dox.in > Magick++.dox
53+
doxygen Magick++.dox
54+
4855
- name: Compare documentation
4956
run: |
5057
diff=""
51-
# first generate the Magick++ documentation to be up to date with the current code
52-
cd ImageMagick/config && doxygen Magick++.dox.in &> /dev/null
53-
cd ../..
54-
5558
# documentation files with function signatures that we can compare with their corresponding doxygen file (currently)
5659
DOC_HTML=("Blob.html" "CoderInfo.html" "Geometry.html" "Image++.html" "Montage.html" "Pixels.html")
5760
DOXY_HTML=("Blob.html" "CoderInfo.html" "Geometry.html" "Image.html" "Montage.html" "Pixels.html") # Image.html is the only one that differs from the doxygen file
5861
for i in "${!DOC_HTML[@]}"; do
5962
python3 .github/build/scripts/compare-signatures.py docs/magick++/"${DOC_HTML[$i]}" ImageMagick/www/api/Magick++/classMagick_1_1"${DOXY_HTML[$i]}"
60-
if [ $? -eq -1 ]; then
63+
if [ $? -ne 0 ]; then
6164
diff="true"
6265
fi
6366
done

0 commit comments

Comments
 (0)