Skip to content

Commit 5f40b01

Browse files
committedApr 4, 2025··
chore(docs): setup versioned docs
1 parent 6f697bf commit 5f40b01

File tree

5 files changed

+141
-0
lines changed

5 files changed

+141
-0
lines changed
 

‎.github/workflows/deploy_dev_docs.yml

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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+
35+
- name: Build Docs Website
36+
run: uv run mike deploy --push develop
+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
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+
33+
- name: Build Docs Website
34+
run: uv run mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest

‎mkdocs.yml

+1
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

‎pyproject.toml

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ description = "A collection of language tools and a Language Server Protocol (LS
55
readme = "README.md"
66
requires-python = ">=3.13"
77
dependencies = [
8+
"mike>=2.1.3",
89
"mkdocs>=1.6.1",
910
"mkdocs-github-admonitions-plugin>=0.0.3",
1011
]

‎uv.lock

+69
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
Please sign in to comment.