Skip to content

Commit 2177e12

Browse files
committed
Add the docs standalone workflow
1 parent 7d2c593 commit 2177e12

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

.github/workflows/docs.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Docs
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
docs:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v4
11+
12+
- name: Set up Python
13+
uses: actions/setup-python@v4
14+
with:
15+
python-version: '3.10'
16+
17+
- name: Install MkDocs and plugins
18+
run: |
19+
python -m pip install --upgrade pip
20+
pip install mkdocs mkdocs-material mkdocstrings
21+
22+
- name: Deploy documentation to GitHub Pages
23+
env:
24+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
25+
run: mkdocs gh-deploy --force --clean --remote-branch gh-pages

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ jobs:
7070
- name: Install MkDocs and Material theme
7171
run: |
7272
python -m pip install --upgrade pip
73-
pip install mkdocs mkdocs-material
73+
pip install mkdocs mkdocs-material mkdocstrings
7474
7575
- name: Deploy documentation to GitHub Pages
7676
env:

0 commit comments

Comments
 (0)