Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch doc generation to official GitHub pages Actions #7

Merged
merged 6 commits into from
Feb 20, 2024
Merged
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
37 changes: 25 additions & 12 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,42 @@
name: Documentation

on:
push:
branches:
- main
paths:
- "*.md"
- docs/**
workflow_dispatch:

# 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-doc:
runs-on: ubuntu-latest

environment:
name: github-pages

steps:
- uses: actions/checkout@v2
- uses: pdm-project/setup-pdm@v2
- uses: actions/checkout@v4
- uses: pdm-project/setup-pdm@v4
with:
python-version: 3.10.5
- name: Build pages
run: |
pdm install --group doc
cd docs && pdm run mkdocs build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/site
path: './docs/site'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
Loading