This repository has been archived by the owner on Jan 18, 2024. It is now read-only.
Build GitHub Pages Documentation #4
This file contains 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: Build GitHub Pages Documentation | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- "docs/**.md" | |
- "mkdocs.yml" | |
workflow_dispatch: | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
with: | |
fetch-depth: 0 | |
- uses: actions/setup-python@v2 | |
with: | |
python-version: 3.11 | |
- name: Install Python dependencies | |
run: | | |
pipx install "poetry>=1.3.0,<1.4.0" | |
poetry config virtualenvs.create false | |
poetry install --with docs --sync | |
- name: Setup git | |
run: | | |
git config --global user.name 'github-actions[bot]' | |
git config --global user.email 'github-actions[bot]@users.noreply.github.com' | |
- name: Publish docs | |
run: poetry run mkdocs gh-deploy |