Merge pull request #44 from melexis/tools-update #46
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: Doxygen | |
| on: push | |
| jobs: | |
| doc: | |
| name: Build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Install Doxygen and other dependencies | |
| run: | | |
| sudo apt update | |
| sudo apt-get install -y doxygen doxygen-doc doxygen-latex doxygen-gui graphviz | |
| pip3 install mlx.warnings | |
| - name: Execute and build documentation | |
| run: | | |
| mlx-warnings --doxygen --exact-warnings 3 --command make doxy | |
| - name: Upload HTML documentation | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: html-doc | |
| path: ./build/html/doxygen/html | |
| deploy: | |
| if: github.event_name == 'push' && contains(github.ref, 'refs/tags/') | |
| needs: doc | |
| name: Publish | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Download HTML documentation from job 'test' | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: html-doc | |
| path: ./build/html/doxygen/html | |
| - name: Disable jekyll | |
| run: touch ./build/html/doxygen/html/.nojekyll | |
| - name: Deploy documentation | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./build/html/doxygen/html |