- Update site name, description, and documentation structure - Enhance MkDocs theme features and navigation - Modify documentation navigation to use nested structure - Improve GitHub Actions workflow with more robust deployment steps - Add site directory configuration for GitHub Pages
34 lines
847 B
YAML
34 lines
847 B
YAML
name: Deploy Documentation
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- 'docs/**'
|
|
- 'mkdocs.yml'
|
|
|
|
jobs:
|
|
deploy:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
contents: write
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
- uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.x'
|
|
cache: 'pip'
|
|
- name: Install dependencies
|
|
run: |
|
|
python -m pip install --upgrade pip
|
|
pip install -r docs/requirements.txt
|
|
- name: Configure Git
|
|
run: |
|
|
git config --global user.name "github-actions[bot]"
|
|
git config --global user.email "github-actions[bot]@users.noreply.github.com"
|
|
- name: Build and Deploy
|
|
run: |
|
|
mkdocs build --strict
|
|
mkdocs gh-deploy --force --clean |