Allow to terminate an epoch without firing Events.EPOCH_COMPLETED
#5021
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: Build docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| paths-ignore: | |
| - "tests/**" | |
| - "docker/**" | |
| release: | |
| types: [published] | |
| workflow_dispatch: | |
| jobs: | |
| build-deploy: | |
| permissions: | |
| contents: write | |
| if: (github.ref == 'refs/heads/master' && github.event_name == 'push') || github.event_name == 'release' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.10" | |
| - run: sudo npm install katex -g | |
| - uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: pip-${{ hashFiles('requirements-dev.txt') }}-${{ hashFiles('docs/requirements.txt') }} | |
| - name: Install docs deps | |
| run: bash .github/workflows/install_docs_deps.sh | |
| - name: Build docs | |
| run: bash .github/workflows/build_docs.sh | |
| - name: Deploy docs | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/build/html | |
| publish_branch: gh-pages | |
| commit_message: Deploy pytorch/ignite docs | |
| force_orphan: true | |
| linkcheck: | |
| if: github.event_name == 'pull_request' || github.event_name == 'push' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.10" | |
| - uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: pip-${{ hashFiles('requirements-dev.txt') }}-${{ hashFiles('docs/requirements.txt') }} | |
| - name: Install docs deps | |
| run: bash .github/workflows/install_docs_deps.sh | |
| - name: make linkcheck | |
| working-directory: ./docs/ | |
| run: make linkcheck | |
| doctest: | |
| if: github.event_name == 'pull_request' || github.event_name == 'push' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.10" | |
| - run: sudo npm install katex -g | |
| - uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: pip-${{ hashFiles('requirements-dev.txt') }}-${{ hashFiles('docs/requirements.txt') }} | |
| - name: Install docs deps | |
| run: bash .github/workflows/install_docs_deps.sh | |
| - name: make doctest | |
| working-directory: ./docs/ | |
| run: | | |
| make html | |
| make doctest | |
| make coverage |