Skip to content

Commit d47999d

Browse files
authored
Add documentation deployment workflow.
Add documentation deployment workflow.
2 parents a947665 + 1b75c3a commit d47999d

65 files changed

Lines changed: 67 additions & 18446 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/deploy-docs.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Deploy MKDocs to GitHub Page
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
deploy:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout repository
16+
uses: actions/checkout@v4
17+
18+
- name: Setup Python
19+
uses: actions/setup-python@v5
20+
with:
21+
python-version: '3.12'
22+
23+
- name: Install dependencies
24+
run: |
25+
python -m pip install --upgrade pip
26+
pip install mkdocs mkdocs-material
27+
28+
- name: Deploy to GitHub Pages
29+
run: mkdocs gh-deploy --force

.github/workflows/lint-format.yml

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
1-
# name: Lint & Format
1+
name: Lint & Format
22

3-
# on:
4-
# push:
5-
# branches: [master]
6-
# pull_request:
7-
# branches: [master]
3+
on:
4+
push:
5+
branches: [master]
6+
pull_request:
7+
branches: [master]
88

9-
# jobs:
10-
# lint-format:
11-
# name: Lint, Format, and Type Check
12-
# runs-on: ubuntu-latest
9+
jobs:
10+
lint-format:
11+
name: Lint, Format, and Type Check
12+
runs-on: ubuntu-latest
1313

14-
# steps:
15-
# - name: Checkout code
16-
# uses: actions/checkout@v3
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v3
1717

18-
# - name: Set up Python
19-
# uses: actions/setup-python@v4
20-
# with:
21-
# python-version: '3.13'
18+
- name: Set up Python
19+
uses: actions/setup-python@v4
20+
with:
21+
python-version: '3.13'
2222

23-
# - name: Install dependencies
24-
# run: |
25-
# python -m pip install --upgrade pip
26-
# pip install black isort mypy
23+
- name: Install dependencies
24+
run: |
25+
python -m pip install --upgrade pip
26+
pip install black isort mypy
2727
28-
# - name: Run black
29-
# run: black .
28+
- name: Run black
29+
run: black .
3030

31-
# - name: Run isort
32-
# run: isort .
31+
- name: Run isort
32+
run: isort .
3333

34-
# - name: Run mypy
35-
# run: mypy .
34+
- name: Run mypy
35+
run: mypy .

mkdocs.yml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -117,17 +117,17 @@ markdown_extensions:
117117

118118
plugins:
119119
- search
120-
- i18n:
121-
default_language: en
122-
languages:
123-
- locale: en
124-
name: English
125-
default: true
126-
build: true
127-
- locale: fr
128-
name: Français
129-
default: false
130-
build: true
120+
# - i18n:
121+
# default_language: en
122+
# languages:
123+
# - locale: en
124+
# name: English
125+
# default: true
126+
# build: true
127+
# - locale: fr
128+
# name: Français
129+
# default: false
130+
# build: true
131131

132132
# - macros:
133133
# on_error_fail: true

0 commit comments

Comments
 (0)