diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 12bbe1a7..03880b70 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,10 +1,14 @@ -name: docs +name: Documentation + on: push: - branches: - - main + branches: [main] + pull_request: + branches: [main] + permissions: contents: write + jobs: deploy: runs-on: ubuntu-latest @@ -16,7 +20,7 @@ jobs: git config user.email 41898282+github-actions[bot]@users.noreply.github.com - uses: actions/setup-python@v4 with: - python-version: 3.x + python-version: 3.11 - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV - uses: actions/cache@v3 with: @@ -25,4 +29,5 @@ jobs: restore-keys: | mkdocs-material- - run: pip install mkdocs-material mkdocstrings + - run: pip install -e . - run: mkdocs gh-deploy --force