-
-
Notifications
You must be signed in to change notification settings - Fork 143
49 lines (43 loc) · 1.36 KB
/
Deploy MkDocs.yml
File metadata and controls
49 lines (43 loc) · 1.36 KB
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
# Deploy MkDocs and push to GitHub Pages
---
name: 📖 Deploy MkDocs to GitHub
# Install, build, and deploy MkDocs to GitHub Pages using content from the Docs folder.
on:
#pull_request:
# branches:
# - main
# paths: # Only deploy MkDocs when the contents of the docs folder change or when this workflow changes
# - 'Docs/**'
# - '.github/workflows/Deploy MkDocs.yml'
# - './mkdocs.yml'
push:
branches:
- main # The branch you want to deploy from
paths: # Only deploy MkDocs when the contents of the docs folder change or when this workflow changes
- 'Docs/**'
- '.github/workflows/Deploy MkDocs.yml'
- './mkdocs.yml'
workflow_dispatch:
jobs:
build:
permissions:
contents: write
runs-on: ubuntu-latest
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
steps:
- name: ✅ Checkout Repository
uses: actions/checkout@v4
- name: 🐍 Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.x' # specify the Python version
- name: ➕ Install Dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material
- name: 👷♂️ Build & Deploy MkDocs
run: |
mkdocs build
mkdocs gh-deploy --force