Skip to content

Github Pages

Github Pages #24

Workflow file for this run

name: Github Pages
on:
workflow_dispatch:
release:
types: [ published ]
jobs:
deploy:
runs-on: ubuntu-latest
env:
python-version: 3.11
permissions:
contents: write
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Set up Python ${{ env.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ env.python-version }}
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
installer-parallel: true
- name: Load cached venv
id: cached-poetry-dependencies
uses: actions/cache@v3
with:
path: .venv
key: venv-${{ runner.os }}-${{ env.python-version }}-${{ hashFiles('**/poetry.lock') }}
- name: Install dependencies
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: poetry install --no-interaction --no-root # --no-root is required to avoid installing the project itself
- name: Build Docs
run: poetry run mkdocs build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site