Repository navigation
whenxuan: black init for the repo #7
This file contains hidden or 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
| # Pack Sphinx-Gallery output and upload it as a GitHub Release asset | |
| # (tag gallery-cache). Read the Docs downloads that tarball in pre_build | |
| # so unchanged examples are skipped and the 15-minute limit is enough. | |
| # | |
| # This is not a software release. The tag is a prerelease so it does not | |
| # become GitHub's "latest" version. | |
| # | |
| # First upload (already have a local gallery): | |
| # tar -czf auto_examples.tar.gz docs/source/auto_examples docs/source/sg_execution_times.rst | |
| # gh release create gallery-cache auto_examples.tar.gz --prerelease \ | |
| # --title "Sphinx-Gallery cache" \ | |
| # --notes "Generated example figures for Read the Docs. Not a software release." | |
| # | |
| # Or: Actions → Gallery cache → Run workflow. | |
| name: Gallery cache | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: [main, master] | |
| paths: | |
| - "examples/**" | |
| - "docs/source/conf.py" | |
| - "docs/requirements.txt" | |
| - ".github/workflows/gallery-cache.yml" | |
| permissions: | |
| contents: write | |
| jobs: | |
| pack: | |
| name: Build and upload gallery cache | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 90 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| cache: pip | |
| - name: Install package and docs extras | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e . | |
| pip install -r docs/requirements.txt | |
| - name: Build HTML (executes Sphinx-Gallery) | |
| env: | |
| MPLBACKEND: Agg | |
| run: sphinx-build -b html docs/source docs/build/html | |
| - name: Pack gallery tree | |
| run: | | |
| tar -czf auto_examples.tar.gz \ | |
| docs/source/auto_examples \ | |
| docs/source/sg_execution_times.rst | |
| - name: Publish rolling GitHub Release | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| run: | | |
| if gh release view gallery-cache >/dev/null 2>&1; then | |
| gh release upload gallery-cache auto_examples.tar.gz --clobber | |
| else | |
| gh release create gallery-cache auto_examples.tar.gz \ | |
| --title "Sphinx-Gallery cache" \ | |
| --notes "Generated example figures for Read the Docs incremental builds. Not a software release." \ | |
| --prerelease | |
| fi |