|
| 1 | +name: "Check Doxygen Documentation" |
| 2 | + |
| 3 | +# This file is part of t8code. |
| 4 | +# t8code is a C library to manage a collection (a forest) of multiple |
| 5 | +# connected adaptive space-trees of general element types in parallel. |
| 6 | +# |
| 7 | +# Copyright (C) 2025 the developers |
| 8 | +# |
| 9 | +# t8code is free software; you can redistribute it and/or modify |
| 10 | +# it under the terms of the GNU General Public License as published by |
| 11 | +# the Free Software Foundation; either version 2 of the License, or |
| 12 | +# (at your option) any later version. |
| 13 | +# |
| 14 | +# t8code is distributed in the hope that it will be useful, |
| 15 | +# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | +# GNU General Public License for more details. |
| 18 | +# |
| 19 | +# You should have received a copy of the GNU General Public License |
| 20 | +# along with t8code; if not, write to the Free Software Foundation, Inc., |
| 21 | +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 22 | + |
| 23 | +# |
| 24 | +# This github CI script runs on every push on a feature branch and in the merge queue. |
| 25 | +# It checks if the doxygen documentation can be built without errors and warnings. |
| 26 | +# |
| 27 | + |
| 28 | +on: |
| 29 | + workflow_call: |
| 30 | + |
| 31 | + # Allows you to run this workflow manually from the actions tab |
| 32 | + workflow_dispatch: |
| 33 | + |
| 34 | +jobs: |
| 35 | + update_dev_doc: |
| 36 | + runs-on: ubuntu-latest |
| 37 | + container: dlramr/t8code-ubuntu:t8-dependencies |
| 38 | + timeout-minutes: 10 |
| 39 | + steps: |
| 40 | + - uses: actions/checkout@v6 |
| 41 | + with: |
| 42 | + repository: ${{ github.event.pull_request.head.repo.full_name }} |
| 43 | + ref: ${{ github.event.pull_request.head.ref }} |
| 44 | + fetch-depth: 0 |
| 45 | + - name: disable ownership checks |
| 46 | + run: git config --global --add safe.directory '*' |
| 47 | + - name: init submodules |
| 48 | + run: git submodule init |
| 49 | + - name: update submodules |
| 50 | + run: git submodule update |
| 51 | + - name: Install LaTeX dependencies |
| 52 | + run: | |
| 53 | + sudo apt-get update |
| 54 | + sudo apt-get install -y \ |
| 55 | + texlive-latex-base \ |
| 56 | + texlive-latex-recommended \ |
| 57 | + texlive-latex-extra \ |
| 58 | + texlive-fonts-recommended \ |
| 59 | + texlive-font-utils \ |
| 60 | + ghostscript |
| 61 | + - name: Which epstopdf |
| 62 | + run: which epstopdf |
| 63 | + - name: Download precompiled doxygen version 1.13.2 from official website |
| 64 | + run: wget https://www.doxygen.nl/files/doxygen-1.13.2.linux.bin.tar.gz |
| 65 | + - name: Unpack doxygen tar file |
| 66 | + run: | |
| 67 | + tar xf doxygen-1.13.2.linux.bin.tar.gz |
| 68 | + mv doxygen-1.13.2/bin/doxygen ./doxygen |
| 69 | + chmod +x ./doxygen |
| 70 | + echo "$PWD" >> $GITHUB_PATH |
| 71 | + - name: Echo doxygen executable and version |
| 72 | + run: | |
| 73 | + which doxygen |
| 74 | + doxygen --version |
| 75 | + - name: build config variables |
| 76 | + run: export CONFIG_OPTIONS="-DT8CODE_BUILD_DOCUMENTATION=ON -DCMAKE_BUILD_TYPE=Debug -DT8CODE_ENABLE_VTK=ON -DVTK_DIR=/usr/local/lib/cmake/vtk-9.1 -DT8CODE_ENABLE_OCC=ON -DT8CODE_ENABLE_NETCDF=ON" |
| 77 | + && echo CONFIG_OPTIONS="$CONFIG_OPTIONS" >> $GITHUB_ENV |
| 78 | + - name: Configure for documentation only |
| 79 | + run: mkdir build && cd build && cmake ../ $CONFIG_OPTIONS |
| 80 | + - name: OnFailUploadLog |
| 81 | + if: failure() |
| 82 | + uses: actions/upload-artifact@v6 |
| 83 | + with: |
| 84 | + name: cmake_doc_build.log |
| 85 | + path: build/config.log |
| 86 | + - name: check doxygen for errors / warnings |
| 87 | + run: | |
| 88 | + cd build && cd doc |
| 89 | + doxygen Doxyfile >> doxygen.out 2> doxygen.err |
| 90 | + - name: Upload doxygen log |
| 91 | + if: failure() |
| 92 | + uses: actions/upload-artifact@v6 |
| 93 | + with: |
| 94 | + name: doxygen-log |
| 95 | + path: build/doc/doxygen.err |
| 96 | + |
0 commit comments