Skip to content

Build Sphinx Documentation and check links #1667

Build Sphinx Documentation and check links

Build Sphinx Documentation and check links #1667

Workflow file for this run

name: Build Sphinx Documentation and check links
on:
schedule:
# Weekly, at 03:00 on Monday UTC
- cron: "0 3 * * 1"
pull_request:
paths:
- ".github/workflows/sphinx.yml"
- "docs/**"
- "README.md"
- "CHANGELOG.md"
push:
branches:
- main
paths:
- ".github/workflows/sphinx.yml"
- "docs/**"
- "README.md"
- "CHANGELOG.md"
workflow_dispatch:
jobs:
build-docs:
permissions:
contents: write
if: github.repository_owner == 'jupyter' || github.repository_owner == 'mathbunnyru' || github.event_name != 'schedule'
runs-on: ubuntu-latest
steps:
- name: Checkout Repo ⚡️
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set Up Python 🐍
uses: actions/setup-python@v5
with:
python-version: 3.9
- name: Install Doc Dependencies 📦
run: |
pip install --upgrade pip
pip install --upgrade -r docs/requirements.txt
- name: Build Documentation 📖
run: make docs
- name: Check Documentation URLs 🔗
run: make linkcheck-docs || make linkcheck-docs