Skip to content

Commit c5e48da

Browse files
committed
test mike
1 parent 3698af5 commit c5e48da

File tree

4 files changed

+69
-55
lines changed

4 files changed

+69
-55
lines changed

.github/workflows/deploy_dev_docs.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Build and Deploy Documentation on Push
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
deploy:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
19+
- name: Install uv
20+
uses: astral-sh/setup-uv@v5
21+
with:
22+
enable-cache: true
23+
24+
- name: Set up Python
25+
run: uv python install
26+
27+
- name: Install the project
28+
run: uv sync --all-extras --dev
29+
30+
- name: Configure Git
31+
run: |
32+
git config user.name 'github-actions[bot]'
33+
git config user.email 'github-actions[bot]@users.noreply.github.com'
34+
- name: Build Docs Website
35+
run: uv run mike deploy --push develop

.github/workflows/deploy_docs.yml

Lines changed: 0 additions & 55 deletions
This file was deleted.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Build and Deploy Release Documentation
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
17+
- name: Install uv
18+
uses: astral-sh/setup-uv@v5
19+
with:
20+
enable-cache: true
21+
22+
- name: Set up Python
23+
run: uv python install
24+
25+
- name: Install the project
26+
run: uv sync --all-extras --dev
27+
28+
- name: Configure Git
29+
run: |
30+
git config user.name 'github-actions[bot]'
31+
git config user.email 'github-actions[bot]@users.noreply.github.com'
32+
- name: Build Docs Website
33+
run: uv run mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ nav:
2525

2626
plugins:
2727
- gh-admonitions
28+
- mike
2829

2930
markdown_extensions:
3031
- admonition

0 commit comments

Comments
 (0)