diff --git a/.github/workflows/deploy_mkdocs.yml b/.github/workflows/deploy_mkdocs.yml index bb95d3e4..211ade6e 100644 --- a/.github/workflows/deploy_mkdocs.yml +++ b/.github/workflows/deploy_mkdocs.yml @@ -5,15 +5,20 @@ on: branches: - main paths: - # Only rebuild website when docs have changed + - 'README.md' + - 'CHANGELOG.md' + - 'CONTRIBUTING.md' + - 'docs/**' + pull_request: + paths: - 'README.md' - 'CHANGELOG.md' - 'CONTRIBUTING.md' - 'docs/**' jobs: - build: - name: Deploy docs + docs: + name: ${{ github.event_name == 'push' && 'Deploy docs' || 'Build docs' }} runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -28,5 +33,10 @@ jobs: python -m pip install --upgrade pip python -m pip install mkdocs mkdocs-material mkdocs-jupyter pandas seaborn folium + - name: Build docs + if: github.event_name == 'pull_request' + run: mkdocs build -f docs/mkdocs.yml + - name: Deploy docs + if: github.event_name == 'push' run: mkdocs gh-deploy --force -f docs/mkdocs.yml