Skip to content

Merge pull request #5818 from boringbyte/fix/_callbacks.py #270

Merge pull request #5818 from boringbyte/fix/_callbacks.py

Merge pull request #5818 from boringbyte/fix/_callbacks.py #270

Workflow file for this run

name: Sphinx
on:
push:
branches:
- master
pull_request: {}
concurrency:
group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/master' && github.run_number || github.ref }}
cancel-in-progress: true
jobs:
documentation:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.12
# note (crcrpar): We've not updated tutorial frequently enough so far thus
# it'd be okay to discard cache by any small changes including typo fix under tutorial directory.
- name: Sphinx Gallery Cache
uses: actions/cache@v3
env:
cache-name: sphx-glry-documentation
with:
path: |
tutorial/MNIST
docs/source/tutorial
key: py3.12-${{ env.cache-name }}-${{ hashFiles('tutorial/**/*') }}
- name: Install Dependencies
run: |
sudo apt-get install optipng
python -m pip install -U pip
pip install --progress-bar off -U .[document] --extra-index-url https://download.pytorch.org/whl/cpu
- name: Output installed packages
run: |
pip freeze --all
- name: Output dependency tree
run: |
pip install pipdeptree
pipdeptree
- name: Build Document
run: |
cd docs
make html
cd ../
- uses: actions/upload-artifact@v4
with:
name: built-html
path: |
docs/build/html
- uses: actions/upload-artifact@v4
with:
name: tutorial
path: |
docs/source/tutorial
doctest:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.12
- name: Sphinx Gallery Cache
uses: actions/cache@v3
env:
cache-name: sphx-glry-doctest
with:
path: |
tutorial/MNIST
docs/source/tutorial
key: py3.12-${{ env.cache-name }}-${{ hashFiles('tutorial/**/*') }}
- name: Install Dependencies
run: |
sudo apt-get install optipng
python -m pip install -U pip
pip install --progress-bar off -U .[document] --extra-index-url https://download.pytorch.org/whl/cpu
- name: Output installed packages
run: |
pip freeze --all
- name: Output dependency tree
run: |
pip install pipdeptree
pipdeptree
- name: Run Doctest
run: |
cd docs
make doctest