2024-07-14 20:44:52 -05:00
|
|
|
name: GitHub Pages Deploy
|
2024-08-09 09:39:00 -05:00
|
|
|
|
2024-07-13 10:59:35 -05:00
|
|
|
on:
|
2024-08-19 14:19:37 -05:00
|
|
|
push:
|
|
|
|
paths:
|
|
|
|
- '.github/mkdocs.yml'
|
|
|
|
- '.github/requirements.txt'
|
|
|
|
- 'docs/**'
|
|
|
|
- 'overrides/**'
|
2024-08-28 20:11:19 -05:00
|
|
|
- '.github/CONTRIBUTING.md'
|
2024-08-06 15:50:36 -05:00
|
|
|
workflow_dispatch:
|
2024-08-09 09:39:00 -05:00
|
|
|
|
2024-07-13 10:59:35 -05:00
|
|
|
jobs:
|
2024-08-19 14:19:37 -05:00
|
|
|
build-and-deploy:
|
2024-07-13 10:59:35 -05:00
|
|
|
runs-on: ubuntu-latest
|
2024-08-09 09:39:00 -05:00
|
|
|
|
2024-07-13 10:59:35 -05:00
|
|
|
steps:
|
2024-08-09 09:39:00 -05:00
|
|
|
- name: Checkout Repository
|
|
|
|
uses: actions/checkout@v4
|
2024-07-13 10:59:35 -05:00
|
|
|
with:
|
2024-08-09 09:39:00 -05:00
|
|
|
fetch-depth: '0' # Fetch all commit history for all branches as well as tags.
|
|
|
|
|
|
|
|
- name: Setup Python
|
|
|
|
uses: actions/setup-python@v5
|
2024-07-13 10:59:35 -05:00
|
|
|
with:
|
2024-08-09 09:39:00 -05:00
|
|
|
python-version: 3.x # Install latest Stable release of Python 3
|
2024-08-19 14:19:37 -05:00
|
|
|
cache: 'pip' # Caching pip dependencies
|
2024-08-09 09:39:00 -05:00
|
|
|
|
2024-08-19 14:19:37 -05:00
|
|
|
- name: Install Necessary Dependencies
|
2024-08-14 10:23:26 -05:00
|
|
|
run: pip install -r .github/requirements.txt
|
2024-08-09 09:39:00 -05:00
|
|
|
|
2024-08-19 14:19:37 -05:00
|
|
|
- name: Build & Deploy using mkdocs
|
|
|
|
run: mkdocs gh-deploy --force -f .github/mkdocs.yml
|