Closed charlesbmi closed 1 year ago
Interesting, this issue results from the mkdocs-
offline plugin, which only runs on CircleCI
. The nice thing about offline
is that the docs are searchable. The downside seems to be that it rearranges the folders and .html
files in a different way than we are expecting.
We expect directory URLs, but the offline plugin swaps to .html
files.
https://github.com/squidfunk/mkdocs-material/blob/950d1e41fb540a29fd785d00e73a1c5ae5e0a2f1/src/plugins/offline/plugin.py#L39-L41
Describe the bug
CircleCI-generated gallery examples don't include images. These images are a helpful validation check that the gallery simulations ran correctly.
(Interestingly, though they do include the
FuncAnimation
s):Steps to reproduce
Expected results
Images should show up in CI-generated example gallery like they do on the main page.
Actual results
CircleCI-generated docs don't include images.
Notes
Potentially related to https://github.com/agencyenterprise/neurotechdevkit/issues/118