Protocol - documentation fix #30
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: documentation | |
| on: [push, workflow_dispatch] | |
| defaults: | |
| run: | |
| shell: bash | |
| jobs: | |
| build-docs-only: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Get CMake | |
| uses: symbitic/install-cmake@master | |
| - name: Install Qt | |
| uses: jurplel/install-qt-action@v3 | |
| with: | |
| install-deps: true | |
| cache: true | |
| - name: Install Doxygen | |
| run: sudo apt install doxygen doxygen-latex | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| with: | |
| repository: ElettraSciComp/witmotion_IMU_QT | |
| submodules: true | |
| path: witmotion_uart | |
| lfs: true | |
| ref: main | |
| - name: Generate CMake env | |
| run: | | |
| cd witmotion_uart && mkdir build && cd build | |
| cmake -DBUILD_DOCS=ON -DBUILD_EXAMPLES=OFF .. | |
| - name: Build documentation | |
| run: cd witmotion_uart/build && make doc-witmotion-uart-qt | |
| - name: Upload GitHub Pages artifacts | |
| uses: actions/[email protected] | |
| with: | |
| path: witmotion_uart/build/doc/html | |
| retention-days: 90 | |
| deploy: | |
| runs-on: ubuntu-latest | |
| needs: build-docs-only | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy HTML documentation to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v1 | |