Skip to content

Clean up docs

Clean up docs #7

Workflow file for this run

name: Deploy to GitHub Pages
on:
push:
branches:
- master
- "**docs**"
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: 'pages'
cancel-in-progress: false
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install dependencies
run: |
pip install mkdocs mkdocs-rtd-dropdown mkdocs-mermaid2-plugin mkdocstrings[python]
- name: Build and deploy
env:
TOKEN: ${{ secrets.ACTIONS_DEPLOY_KEY }}
run: |
git config --global user.name 'github-actions[bot]'
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
mkdocs gh-deploy --force --remote-branch gh-pages --remote-name origin --message "Deploy to GitHub Pages"