Skip to content
name: Documentation Deployment
on:
push:
branches:
- main
workflow_dispatch:
jobs:
build-deploy-docs:
runs-on: ubuntu-latest
steps:
- name: Check out the repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt # Specify documentation dependencies
- name: Build documentation
run: |
mkdocs build
- name: Deploy documentation
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site