Skip to content

Commit 83f7bf2

Browse files
committed
Add GitHub Pages docs workflow
1 parent 1adac28 commit 83f7bf2

File tree

2 files changed

+41
-7
lines changed

2 files changed

+41
-7
lines changed

.github/workflows/docs.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Build and Deploy Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- development
7+
- main
8+
- master
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: write
13+
14+
jobs:
15+
docs:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout
19+
uses: actions/checkout@v4
20+
21+
- name: Setup Python
22+
uses: actions/setup-python@v5
23+
with:
24+
python-version: "3.x"
25+
26+
- name: Install MkDocs
27+
run: |
28+
python -m pip install --upgrade pip
29+
pip install mkdocs mkdocs-material
30+
31+
- name: Build site
32+
run: mkdocs build --strict
33+
34+
- name: Deploy to gh-pages
35+
uses: peaceiris/actions-gh-pages@v3
36+
with:
37+
github_token: ${{ secrets.GITHUB_TOKEN }}
38+
publish_dir: ./site
39+
publish_branch: gh-pages
40+
force_orphan: true

mkdocs.yml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,8 @@ nav:
4242
- Troubleshooting: troubleshooting.md
4343
- Compatibility And Regression Matrix: testing/compatibility_matrix.md
4444
- Reference:
45-
- Corpus API: api/corpus.md
45+
- Corpus API: api_corpus_tmp.md
4646
- Math Enrichment Runtime: math_enrichment_runtime.md
47-
- Divio Skeleton:
48-
- Overview: divio/overview.md
49-
- Tutorials: divio/tutorials.md
50-
- How-to Guides: divio/how_to_guides.md
51-
- Reference: divio/reference.md
52-
- Explanation: divio/explanation.md
5347
docs_dir: docs
5448
markdown_extensions:
5549
- admonition

0 commit comments

Comments
 (0)