Adopt MkDocs and use Read the Docs theme #1
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: Publish | |
permissions: | |
contents: write | |
deployments: write | |
on: | |
workflow_dispatch: | |
push: | |
branches: | |
- main | |
jobs: | |
pages: | |
runs-on: ubuntu-22.04 | |
steps: | |
- uses: actions/checkout@v4.1.1 | |
with: | |
fetch-depth: 0 | |
- name: Setup Python | |
uses: actions/setup-python@v5.1.0 | |
with: | |
python-version: '3.12' | |
- name: Setup Dependencies | |
run: pip install -r requirements.txt | |
- name: Build & Publish | |
run: python -m mkdocs gh-deploy | |
- run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com' | |
- uses: actions/upload-artifact@v4.3.1 | |
with: | |
path: './site' | |