-
Notifications
You must be signed in to change notification settings - Fork 57
63 lines (59 loc) · 1.63 KB
/
update-mkdocs.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
name: Build/Publish Docs on main
on:
push:
branches:
- main
paths:
- '.github/**'
- 'docs/**'
- 'mkdocs.yml'
tags-ignore: ['**']
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: 3.11.6
- name: Install Dependencies
run: |
pip install -r docs/requirements.txt
- name: Setup Docs Deploy
run: |
git config --global user.name "Docs Deploy"
git config --global user.email "[email protected]"
- name: Build Docs Website
run: mike deploy --config-file mkdocs.yml --push develop
# name: Update Docs
# on:
# push:
# branches:
# - main
# paths:
# - '.github/**'
# - 'docs/**'
# - 'mkdocs.yml'
# jobs:
# build:
# name: Deploy docs
# runs-on: ubuntu-latest
# steps:
# - name: Checkout main
# uses: actions/checkout@v4
#
# - name: Deploy docs
# uses: synfinatic/mkdocs-deploy-gh-pages@bump-mkdocs
# # mhausenblas/mkdocs-deploy-gh-pages@master is an old version of mkdocs, so using my own
# # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# # CUSTOM_DOMAIN: optionaldomain.com
# CONFIG_FILE: mkdocs.yml
# # EXTRA_PACKAGES: build-base
# # GITHUB_DOMAIN: github.myenterprise.com
# REQUIREMENTS: docs/requirements.txt