Skip to content

Merge pull request #212 from scipy/release_2.0.1 #84

Merge pull request #212 from scipy/release_2.0.1

Merge pull request #212 from scipy/release_2.0.1 #84

Workflow file for this run

name: Build & Deploy Docs
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
jobs:
# Build the docs
docs-build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Set up Python 3.12
uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
with:
python-version: "3.12"
cache: "pip"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -e '.[doc]'
- name: Build Docs
run: |
sphinx-build -b html docs/ docs/build/
- name: Upload Artifact
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
name: docs-build
path: docs/build/
# Deploy the docs to GitHub Pages
docs-deploy:
if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }}
runs-on: ubuntu-latest
needs: docs-build
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
contents: write
pages: write
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Download Artifact
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
with:
name: docs-build
path: docs/build/
- name: Deploy to GitHub pages
uses: JamesIves/github-pages-deploy-action@6c2d9db40f9296374acc17b90404b6e8864128c8 # v4.7.3
with:
folder: docs/build/