search

modflowpy / flopy

A Python package to create, run, and post-process MODFLOW-based models.
https://flopy.readthedocs.io
Other
506 stars 306 forks source link

bug: The Example Gallery appears to be not building correctly #2253

Closed aleaf closed 1 month ago

aleaf commented 1 month ago

Describe the bug The Example Gallery is just showing the category headers with no thumbnails or links, in both the "latest" and "stable" versions.

To Reproduce Steps to reproduce the behavior:

  1. Go to URL above

Expected behavior A clear and concise description of what you expected to happen.

Screenshots

image

Desktop (please complete the following information):

Additional context Add any other context about the problem here.

wpbonelli commented 1 month ago

This is on me. I switched the default version to stable after discussion with @langevin-usgs (motivated by #2251), which triggered a rebuild on RTD, but we typically trigger an RTD build from GH actions after creating/uploading notebooks since they take too long to run on the RTD build service. Working on fixing it

aleaf commented 1 month ago

No worries, thanks for fixing! And glad it sounds like an easy fix...

wpbonelli commented 1 month ago

Latest should soon be fixed. Stable is trickier as GH requires updating the branch before the manual trigger can be used.

Outdated As a one-time fix I pushed a commit to master to trigger a build and will revert it when the build completes.

To attempt to fix this the rtd.yml workflow can now be manually dispatched and the branch/tag/commit from which to build the RTD site can be configured.

In the longer term, shortening notebook runtime enough to run them on RTD and avoid the problem would be ideal — notebooks are taking ~13 mins on GH runners, so not too much optimization should be needed.

xrefs:

wpbonelli commented 1 month ago

The gallery is back up on latest/develop and stable/master. The thumbnails are broken on stable due to dependency warnings. The 3.7.0 docs version remains broken, thus hidden, due to other issues — timeout due to building non-html docs versions, for one, which has since been changed, but fixing retrospectively would require rewriting history or temporary commits to protected branches. I tried yesterday, but it got messy quickly. Figure better to just make a new release fairly soon.