Skip to content

Fix broken gallery thumbnails in the published docs#536

Merged
Mbompr merged 1 commit intoX-DataInitiative:masterfrom
Mbompr:docs/fix-example-gallery
Apr 22, 2026
Merged

Fix broken gallery thumbnails in the published docs#536
Mbompr merged 1 commit intoX-DataInitiative:masterfrom
Mbompr:docs/fix-example-gallery

Conversation

@Mbompr
Copy link
Copy Markdown
Contributor

@Mbompr Mbompr commented Apr 22, 2026

Summary

After #535 rebuilt the docs with make html, several examples on https://x-datainitiative.github.io/tick/auto_examples/ rendered as black placeholder squares. Two causes in the build log:

  • tick.plot.qq_plots imports statsmodels lazily, so every example that uses it (plot_hawkes_finance_data, plot_hawkes_em, the qq_plot_* group) crashed with ModuleNotFoundError during the gallery run, and the extension fell back to the broken-image thumbnail. Fixed by adding statsmodels to the docs extra.
  • pip install .[docs,plot] printed WARNING: tick 0.8.0.1 does not provide the extra 'plot' — the plot extra doesn't exist in pyproject.toml; matplotlib is already a core dependency. Dropped the phantom ,plot from the workflow and doc/README.md.

Not in scope

plot_asynchronous_stochastic_solver.py still fails with ASAGA 2 has no history for time. That's a real bug in the example code (or in solver history tracking for ASAGA) and needs its own fix.

Test plan

  • Confirm the Build Docs workflow no longer prints the extra 'plot' warning during install.
  • After merge, verify the gallery pages for plot_hawkes_em, plot_hawkes_finance_data, and qq_plot_hawkes_* show real figures instead of black squares.

🤖 Generated with Claude Code

Two issues were producing the "black square" placeholder images on
x-datainitiative.github.io/tick:

* `tick.plot.qq_plots` imports `statsmodels` lazily, so any example
  calling it (`plot_hawkes_finance_data`, `plot_hawkes_em`, the
  `qq_plot_*` group) blew up with `ModuleNotFoundError` during the
  gallery run and the extension fell back to the broken-image stub.
  Add `statsmodels` to the `docs` extra so docs builds pull it in.
* `pip install .[docs,plot]` printed
  `WARNING: tick 0.8.0.1 does not provide the extra 'plot'` because
  no `plot` extra exists; `matplotlib` already lives in the core
  dependencies. Drop the phantom reference from the workflow and the
  doc README.

Unrelated: `plot_asynchronous_stochastic_solver.py` still fails with
`ASAGA 2 has no history for time` and needs a dedicated fix.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@Mbompr Mbompr merged commit 16169d5 into X-DataInitiative:master Apr 22, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant