Quality of life improvements and better docs #112
Workflow file for this run
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
# creates the documentation on pushes it to the gh-pages branch | |
name: Documentation | |
on: | |
pull_request: | |
branches: [main] | |
push: | |
branches: [main] | |
permissions: | |
contents: write | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: '3.10' | |
- name: Dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install "turftopic[pyro-ppl]" "griffe" "mkdocstrings[python]" "mkdocs" "mkdocs-material" | |
- name: Build and Deploy | |
if: github.event_name == 'push' | |
run: mkdocs gh-deploy --force | |
- name: Build | |
if: github.event_name == 'pull_request' | |
run: mkdocs build |