Skip to content

Commit c75e8df

Browse files
committed
Add GitHub Workflow for generating and deploying to Pages
1 parent 3991c06 commit c75e8df

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

Diff for: .github/workflows/docs.yml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: pages
2+
run-name: Deploy docs
3+
4+
on:
5+
push:
6+
branches:
7+
- master
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- run: pip install mkdocs mkdocs-material
15+
- run: cd docs
16+
- run: mkdocs build -f mkdocs.yml
17+
- name: Upload GitHub Pages artifact
18+
uses: actions/[email protected]
19+
with:
20+
path: site
21+
22+
deploy:
23+
needs: build
24+
permissions:
25+
pages: write
26+
id-token: write
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Deploy to GitHub Pages
33+
id: deployment
34+
uses: actions/deploy-pages@v2

Diff for: .gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
/.venv
2+
/site/

0 commit comments

Comments
 (0)