From fcce0d359f362fc997fb2e63586de3739c6cc498 Mon Sep 17 00:00:00 2001 From: Dirk Lemstra Date: Sun, 16 Feb 2025 09:55:45 +0100 Subject: [PATCH] Cosmetic changes. --- .github/workflows/doc-check.yml | 70 ++++++++++++++++----------------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/.github/workflows/doc-check.yml b/.github/workflows/doc-check.yml index 0e66b19664..7ce3e5d45e 100644 --- a/.github/workflows/doc-check.yml +++ b/.github/workflows/doc-check.yml @@ -1,59 +1,59 @@ -name: Documentation Check for Magick++ +name: Documentation check for Magick++ on: push: branches: - - main + - main paths: - - '.github/workflows/doc_check.yml' + - '.github/workflows/doc_check.yml' pull_request: branches: - - main + - main paths: - - '.github/workflows/doc_check.yml' + - '.github/workflows/doc_check.yml' workflow_dispatch: schedule: - cron: 0 6 * * 1 jobs: doxygen-check: - name: 'Documentation Check' + name: 'Documentation check' runs-on: ubuntu-24.04 steps: - - name: Checkout repository content - uses: actions/checkout@v4 + - name: Checkout repository content + uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - with: - python-version: '3.13' + - uses: actions/setup-python@v5 + with: + python-version: '3.13' - - name: Install Python dependencies - run: python -m pip install --user pyarrow beautifulsoup4 pandas lxml + - name: Install Python dependencies + run: python -m pip install --user pyarrow beautifulsoup4 pandas lxml - - name: Install Doxygen - run: sudo apt-get update && sudo apt-get install -y doxygen + - name: Install Doxygen + run: sudo apt-get update && sudo apt-get install -y doxygen - - name: Compare documentation - run: | - diff=false - # first generate the Magick++ documentation to be up to date with the current code - cd config && doxygen Magick++.dox.in &> /dev/null - cd .. + - name: Compare documentation + run: | + diff=false + # first generate the Magick++ documentation to be up to date with the current code + cd config && doxygen Magick++.dox.in &> /dev/null + cd .. - # documentation files with function signatures that we can compare with their corresponding doxygen file (currently) - DOC_HTML=("Blob.html" "CoderInfo.html" "Geometry.html" "Image++.html" "Montage.html" "Pixels.html") - 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 - for i in "${!DOC_HTML[@]}"; do - python3 .github/scripts/compare_signatures.py www/Magick++/"${DOC_HTML[$i]}" www/api/Magick++/classMagick_1_1"${DOXY_HTML[$i]}" - if [ $? -eq -1 ]; then - diff=true - fi - echo "" - done - - if [ $diff ]; then - echo "Mismatches detected!" && exit 1 + # documentation files with function signatures that we can compare with their corresponding doxygen file (currently) + DOC_HTML=("Blob.html" "CoderInfo.html" "Geometry.html" "Image++.html" "Montage.html" "Pixels.html") + 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 + for i in "${!DOC_HTML[@]}"; do + python3 .github/scripts/compare_signatures.py www/Magick++/"${DOC_HTML[$i]}" www/api/Magick++/classMagick_1_1"${DOXY_HTML[$i]}" + if [ $? -eq -1 ]; then + diff=true fi - exit 0 + echo "" + done + + if [ $diff ]; then + echo "Mismatches detected!" && exit 1 + fi + exit 0