Improve ReadMe #23
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: Doxygen Action | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| env: | |
| # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.) | |
| BUILD_TYPE: Debug | |
| jobs: | |
| Doxygen: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Install Doxygen | |
| run: | | |
| sudo apt-get install doxygen | |
| sudo apt install graphviz | |
| - name: Generate documentation | |
| run: | | |
| cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DBUILD_DIAG_CLIENT:BOOL=OFF -DBUILD_DOXYGEN:BOOL=ON -DCMAKE_TOOLCHAIN_FILE=toolchains/linux_gcc_9.cmake | |
| cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} | |
| - name: Publish | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: github.ref == 'refs/heads/main' | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ${{github.workspace}}/build/docs/html | |