add github-pages #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Deploy Documentation | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- 'documentation/**' | |
- '.github/workflows/deploy-docs.yml' | |
workflow_dispatch: # Allows manual triggering | |
permissions: | |
contents: write | |
pages: write | |
id-token: write | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 # Fetch all history for proper versioning | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.10' | |
- name: Install uv | |
uses: astral-sh/setup-uv@v3 | |
- name: Create virtual environment and install dependencies | |
run: | | |
uv venv | |
source .venv/bin/activate | |
uv pip install mkdocs-material mkdocstrings-python pymdown-extensions | |
uv pip install mike mkdocs-macros-plugin mkdocs-privacy-plugin | |
- name: Setup Git for mike versioning | |
run: | | |
git config --global user.name "github-actions" | |
git config --global user.email "[email protected]" | |
- name: Deploy documentation | |
working-directory: ./documentation | |
run: | | |
source ../.venv/bin/activate | |
mkdocs gh-deploy --force |