Skip to content

Commit beb6de9

Browse files
mmschlkclaude
andauthored
Adds Examples with sphinx gallery.
* docs: add sphinx-gallery for runnable example scripts Introduces sphinx-gallery as an alternative to Jupyter notebooks for lightweight, fast-running code examples. Adds a minimal example script (weighted voting game with Shapley values) and gitignores the generated auto_examples/ output directory. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * ci: fail docs build on warnings Adds -W --keep-going to sphinx-build so the doc_build job treats any Sphinx warning as an error. --keep-going ensures all warnings are reported before the build exits. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 002bd39 commit beb6de9

14 files changed

Lines changed: 2189 additions & 3 deletions

.github/workflows/ci.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,9 +145,8 @@ jobs:
145145
sudo apt-get install -y pandoc
146146
- name: Install dependencies
147147
run: uv sync --no-dev --group docs
148-
# TODO(mmshlk) Turn this step to fail on warnings in the future.
149148
- name: Build documentation
150-
run: uv run --no-sync sphinx-build -b html docs/source docs/build/html
149+
run: uv run --no-sync sphinx-build -W --keep-going -b html docs/source docs/build/html
151150
# ----------------------------------------------------------------------------------------------
152151
# Code Coverage
153152
# ----------------------------------------------------------------------------------------------

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,3 +182,5 @@ game_storage/*
182182

183183
# install artifacts
184184
src/shapiq/_version.py
185+
docs/source/auto_examples/
186+
docs/source/sg_execution_times.rst
13.4 KB
Loading
3.66 KB
Binary file not shown.

0 commit comments

Comments
 (0)