Skip to content

Commit 3fc822a

Browse files
committed
deploy docs to GitHub Pages
1 parent f7f9911 commit 3fc822a

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

.github/workflows/docs.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ name: Docs
22

33
on:
44
push:
5+
branches: ["main"]
56
paths:
67
- "docs/**"
78
- "mkdocs.yml"
@@ -15,9 +16,13 @@ on:
1516
- "README.md"
1617
- "pyproject.toml"
1718
- ".github/workflows/docs.yml"
19+
workflow_dispatch:
20+
21+
permissions:
22+
contents: write
1823

1924
jobs:
20-
docs-check:
25+
deploy:
2126
runs-on: ubuntu-latest
2227
steps:
2328
- name: Checkout
@@ -34,6 +39,6 @@ jobs:
3439
python -m pip install --upgrade pip
3540
python -m pip install -e ".[docs]"
3641
37-
- name: Build docs
42+
- name: Build and deploy docs
3843
run: |
39-
mkdocs build --strict
44+
mkdocs gh-deploy --force

0 commit comments

Comments
 (0)