Skip to content

update docs #96

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.

Sign up for GitHub

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

Merged
JimyMa merged 1 commit into from
May 10, 2026
Merged

update docs #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 16 additions & 4 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,19 @@ on:
permissions:
contents: write

concurrency:
group: docs-pages
cancel-in-progress: false

jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Set up Python
uses: actions/setup-python@v5
Expand All @@ -38,12 +44,17 @@ jobs:
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"

- name: Fetch existing Pages branch
run: |
git fetch origin gh-pages:refs/remotes/origin/gh-pages || true

- name: Deploy development docs
if: github.ref_type == 'branch'
run: |
cd docs
mike deploy --push --update-aliases dev latest
mike set-default --push latest
mike deploy --update-aliases dev latest
mike set-default latest
git push origin gh-pages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Expand All @@ -52,7 +63,8 @@ jobs:
run: |
cd docs
VERSION="${GITHUB_REF_NAME#v}"
mike deploy --push --update-aliases "$VERSION" latest
mike set-default --push latest
mike deploy --update-aliases "$VERSION" latest
mike set-default latest
git push origin gh-pages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}