Skip to content

Correct order, also mention this in README.md #25

Correct order, also mention this in README.md

Correct order, also mention this in README.md #25

Workflow file for this run

name: Docs
on:
push:
branches:
- master
jobs:
build-deploy:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
-
name: Checkout
uses: actions/checkout@v4
# Docs: https://github.com/actions/checkout
-
name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.x
architecture: x64
-
name: Cache
uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
-
name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
-
name: Mkdocs
run: |
mkdocs build --verbose --clean --strict
-
name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site