Add awesome docs (#13) #32
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: Deploy doxygen docs | |
on: | |
push: | |
branches: ["main", "docsupdate"] | |
workflow_dispatch: | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
concurrency: | |
group: "pages" | |
cancel-in-progress: true | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Install requirements | |
run: sudo apt-get install -y ninja-build doxygen | |
- name: Checkout | |
uses: actions/checkout@v3 | |
# For doc gen present should not be used, since the multi config is not needed, but keep that for now | |
- name: Configure project | |
run: cmake -S . -B build/default | |
- name: Build documentation | |
run: cmake --build build/default --parallel --target doc | |
- name: Upload site artifact | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: 'build/default/doc/html/' | |
deploy: | |
needs: build | |
if: github.ref == 'refs/heads/main' | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v3 | |
- name: Setup Pages | |
uses: actions/configure-pages@v2 | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v1 |