64 lines
1.4 KiB
YAML
64 lines
1.4 KiB
YAML
name: Deploy MkDocs Documentation
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- master
|
|
pull_request:
|
|
branches:
|
|
- master
|
|
|
|
permissions:
|
|
contents: write
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-22.04
|
|
steps:
|
|
- name: Checkout code
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Setup Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.10'
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
pip install --upgrade pip
|
|
pip install mkdocs-material mkdocstrings[python] mkdocs-git-revision-date-localized-plugin
|
|
|
|
- name: Set PYTHONPATH
|
|
run: echo "PYTHONPATH=$(pwd)" >> $GITHUB_ENV
|
|
|
|
- name: Build docs
|
|
run: mkdocs build
|
|
|
|
deploy:
|
|
needs: build
|
|
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
|
|
runs-on: ubuntu-22.04
|
|
steps:
|
|
- name: Checkout code
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Setup Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.10'
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
pip install --upgrade pip
|
|
pip install mkdocs-material mkdocstrings[python] mkdocs-git-revision-date-localized-plugin
|
|
|
|
- name: Set PYTHONPATH
|
|
run: echo "PYTHONPATH=$(pwd)" >> $GITHUB_ENV
|
|
|
|
- name: Deploy docs
|
|
run: mkdocs gh-deploy --force
|