fix: fixes interactive function inspection and cleans dependencies #24
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: Docs | |
on: | |
push: | |
branches: | |
- main | |
permissions: | |
contents: write | |
jobs: | |
deploy-docs: | |
name: Deploy documentation | |
runs-on: ubuntu-latest | |
steps: | |
# Checkout this repository and cd to project root, set up python/pdm and cache | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Configure Git Credentials | |
run: | | |
git config user.name github-actions[bot] | |
git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
- uses: pdm-project/setup-pdm@v4 | |
with: | |
python-version: 3.11 | |
cache: true | |
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | |
- uses: actions/cache@v4 | |
with: | |
key: mkdocs-material-${{ env.cache_id }} | |
path: .cache | |
restore-keys: | | |
mkdocs-material- | |
# Build and push docs to gh-pages branch (triggers doc site publish action) | |
- run: pdm sync -G doc -G test | |
- run: pdm run test # to generate coverage report | |
- run: pdm run mkdocs gh-deploy --force |