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 and Deploy Static Mkdocs Documentation | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- 'mkdocs.yml' | |
- 'docs/*' | |
workflow_dispatch: | |
# A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
jobs: | |
github-pages: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v3 | |
with: | |
python-version: 3.x | |
# install dependencies | |
- run: pip install --upgrade pip | |
- run: pip install mkdocs mkdocs-material | |
# Build the documentation | |
- run: mkdocs build | |
# Deploy using ghp-import | |
- run: mkdocs gh-deploy --remote-branch gh-pages --force |