Skip to content

Render plot used everywhere #104

Render plot used everywhere

Render plot used everywhere #104

Workflow file for this run

name: Check Sphinx Docs
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
docs:
name: Build Sphinx Documentation
runs-on: ubuntu-latest
defaults:
run:
shell: bash -eo pipefail {0} # Fail on error and enable pipefail
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.11
cache: "pip"
cache-dependency-path: "**/pyproject.toml"
- name: Install dependencies
run: |
python -m pip install --upgrade pip wheel
pip install ".[doc]"
- name: Build Documentation and Check for Issues
working-directory: docs
run: |
make clean
# Build the docs and capture output, treat warnings as errors (-W)
sphinx-build -b html -W . _build/html 2>&1 | tee sphinx-output.log
- name: Upload Log if Build Failed
if: failure()
uses: actions/upload-artifact@v3
with:
name: sphinx-output-log
path: docs/sphinx-output.log