diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 8c78bf0..1846056 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -3,6 +3,15 @@ name: Documentation on: push: branches: [main] + paths: + - mkdocs.yml + - 'docs/**' + - 'src/**' + pull_request: + paths: + - mkdocs.yml + - 'docs/**' + - 'src/**' workflow_dispatch: jobs: @@ -20,6 +29,7 @@ jobs: uses: actions/setup-python@v5 with: python-version: '3.10' + cache: "pip" - name: Configure git run: | @@ -27,8 +37,12 @@ jobs: git config user.email 'github-actions[bot]@users.noreply.github.com' - name: Install requirements - run: pip install -r docs/requirements.txt + run: pip install -e '.[docs]' - - name: Publish docs + - name: Build docs + if: github.event_name == 'pull_request' + run: mkdocs build -s + - name: Publish docs + if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }} run: mkdocs gh-deploy