Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 30 additions & 14 deletions .github/workflows/docs_pages.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
name: Docs2Pages
on: [ push, pull_request, workflow_dispatch ]
permissions:
contents: write

concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
permissions: {}

jobs:
build-docs:
build:
runs-on: ubuntu-latest
concurrency:
group: docs-build-${{ github.ref }}
cancel-in-progress: true
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@v5
Expand All @@ -24,14 +25,29 @@ jobs:
run: uv sync --all-extras

- name: Build MkDocs site
run: |
uv run mkdocs build --strict
run: uv run mkdocs build --strict

- name: Deploy documentation
uses: peaceiris/actions-gh-pages@v4
- name: Upload Pages artifact
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html
force_orphan: true
path: ./docs/build/html

deploy:
needs: build
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
# Per GitHub Pages guidance: don't cancel an in-flight deploy.
concurrency:
group: pages
cancel-in-progress: false
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading