Skip to content

ci: Deploy documentation to GitHub environment #1

ci: Deploy documentation to GitHub environment

ci: Deploy documentation to GitHub environment #1

Workflow file for this run

# This workflow file is adapted from https://github.com/actions/starter-workflows/blob/f3c5d7931d054ffbbdcbfdc463cc3bd0def74929/pages/mdbook.yml
# which is licensed under the MIT license.
name: Build and deploy documentation
on:
push:
branches: ["main"]
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install pip dependencies
run: pip install -r docs/requirements.txt
- name: Install doxygen
run: sudo apt-get install -y doxygen
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
- name: Build mkdocs
run: mkdocs build
- name: Build doxygen
run: |
doxygen
mv doxygen_output/html html/doxygen
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./html
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2