Rename template argument #855
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | |
| name: Test building documentation | |
| on: | |
| pull_request: | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| jobs: | |
| changes: | |
| name: Detect changes | |
| runs-on: ubuntu-latest | |
| outputs: | |
| cpp: ${{ steps.filter.outputs.cpp }} | |
| python: ${{ steps.filter.outputs.python }} | |
| doc: ${{ steps.filter.outputs.doc }} | |
| any: ${{ steps.filter.outputs.any }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Detect changes | |
| uses: dorny/paths-filter@v3 | |
| id: filter | |
| with: | |
| filters: | | |
| build_files: &build_files | |
| - '.github/workflows/test_doc.yml' | |
| - 'build' | |
| - 'build.bat' | |
| - 'build_system/main.py' | |
| - 'build_system/core/**' | |
| - 'build_system/util/**' | |
| - 'build_system/targets/*.py' | |
| cpp: &cpp | |
| - *build_files | |
| - 'build_system/targets/documentation/cpp/*' | |
| - 'cpp/**/include/**' | |
| python: &python | |
| - *build_files | |
| - 'build_system/targets/documentation/python/*' | |
| - 'python/subprojects/**/mlrl/**' | |
| doc: &doc | |
| - *build_files | |
| - 'build_system/targets/documentation/*' | |
| - 'doc/**' | |
| any: | |
| - *cpp | |
| - *python | |
| - *doc | |
| build_doc: | |
| needs: changes | |
| if: ${{ needs.changes.outputs.any == 'true' }} | |
| name: Test building documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version-file: .version-python | |
| - name: Prepare ccache | |
| uses: hendrikmuhs/ccache-action@v1 | |
| with: | |
| key: test-doc-ccache | |
| - name: Install Doxygen | |
| uses: ssciwr/doxygen-install@v1 | |
| - name: Generate C++ Apidoc | |
| if: ${{ needs.changes.outputs.cpp == 'true' && needs.changes.outputs.doc != 'true' }} | |
| run: GPU_SUPPORT=disabled ./build apidoc_cpp | |
| - name: Generate Python Apidoc | |
| if: ${{ needs.changes.outputs.python == 'true' && needs.changes.outputs.doc != 'true' }} | |
| run: GPU_SUPPORT=disabled ./build apidoc_python | |
| - name: Install Roboto font | |
| if: ${{ needs.changes.outputs.doc == 'true' }} | |
| run: sudo apt install -y fonts-roboto | |
| - name: Generate Documentation | |
| if: ${{ needs.changes.outputs.doc == 'true' }} | |
| run: GPU_SUPPORT=disabled ./build doc | |
| check_links: | |
| needs: changes | |
| if: ${{ needs.changes.outputs.any == 'true' }} | |
| name: Check links in documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version-file: .version-python | |
| - name: Prepare ccache | |
| uses: hendrikmuhs/ccache-action@v1 | |
| with: | |
| key: test-doc-ccache | |
| - name: Install Doxygen | |
| uses: ssciwr/doxygen-install@v1 | |
| - name: Install Roboto font | |
| run: sudo apt install -y fonts-roboto | |
| - name: Generate Documentation | |
| run: GPU_SUPPORT=disabled SPHINX_BUILDER=linkcheck ./build doc |