name: Deploy Documentation on: push: branches: [main] paths: ['docs/**', 'docs-site/**', 'mkdocs.yml'] pull_request: branches: [main] paths: ['docs/**', 'docs-site/**', 'mkdocs.yml'] permissions: contents: read pages: write id-token: write actions: read concurrency: group: "pages" cancel-in-progress: false jobs: build: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 - name: Setup Python uses: actions/setup-python@v4 with: python-version: '3.10' - name: Install dependencies run: | python -m pip install --upgrade pip pip install mkdocs mkdocs-material - name: Setup Pages uses: actions/configure-pages@v4 with: enablement: true - name: Build documentation run: | cd docs-site mkdocs build --site-dir ../site - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: path: site deploy: environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest needs: build if: github.ref == 'refs/heads/main' steps: - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v4 with: token: ${{ secrets.GITHUB_TOKEN }}