Skip to content

Commit 317ca82

Browse files
authored
Automate docs deployment (#9759)
On pushes to master, when the content of the docs or its config chnages
1 parent c0166d9 commit 317ca82

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

.github/workflows/mkdocs-deploy.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: mkdocs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
paths:
8+
- docs/**
9+
- docs_theme/**
10+
- requirements/requirements-documentation.txt
11+
- mkdocs.yml
12+
- .github/workflows/mkdocs-deploy.yml
13+
14+
jobs:
15+
deploy:
16+
runs-on: ubuntu-latest
17+
environment: github-pages
18+
permissions:
19+
contents: write
20+
concurrency:
21+
group: ${{ github.workflow }}-${{ github.ref }}
22+
steps:
23+
- uses: actions/checkout@v4
24+
- run: git fetch --no-tags --prune --depth=1 origin gh-pages
25+
- uses: actions/setup-python@v5
26+
with:
27+
python-version: 3.x
28+
- run: pip install -r requirements/requirements-documentation.txt
29+
- run: mkdocs gh-deploy

0 commit comments

Comments
 (0)