Skip to content

Commit 63de6cc

Browse files
committed
Adding build workflows
Adding build_documentation.yml for GH pages build.
1 parent 5b57a0a commit 63de6cc

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Build Documentation
2+
3+
on:
4+
# Runs on pushes targeting the default branch
5+
push:
6+
branches: ["main"]
7+
8+
# Allows you to run this workflow manually from the Actions tab
9+
workflow_dispatch:
10+
11+
# Sets permissions of the GITHUB_TOKEN to allow files to be committed to gh-pages branch
12+
permissions:
13+
contents: write
14+
15+
16+
jobs:
17+
deploy:
18+
runs-on: ubuntu-latest
19+
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
26+
- name: Instal pgnquant for optimize plugin
27+
run: sudo apt-get install pngquant
28+
29+
- name: Set up Python runtime
30+
uses: actions/setup-python@v5
31+
with:
32+
python-version: 3.x
33+
34+
- name: Install Python dependencies
35+
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'
36+
37+
- name: Set up build cache
38+
run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
39+
- uses: actions/cache@v4
40+
with:
41+
key: mkdocs-material-${{ env.cache_id }}
42+
path: .cache
43+
restore-keys: |
44+
mkdocs-material-
45+
46+
- name: Install Insiders build
47+
env:
48+
MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
49+
run: pip install git+https://${MKDOCS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
50+
- run: mkdocs gh-deploy --clean

0 commit comments

Comments
 (0)