Document requirements for downloaded demonstrations - #1328
Open
sylvesterkaczmarek wants to merge 1 commit into
Open
Document requirements for downloaded demonstrations#1328sylvesterkaczmarek wants to merge 1 commit into
sylvesterkaczmarek wants to merge 1 commit into
Conversation
sylvesterkaczmarek
requested review from
fcmuller-dstl and
jswright-dstl
and removed request for
a team
August 18, 2026 11:01
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improves the documentation around downloaded Stone Soup demonstrations, addressing the remaining usability problem described in #1050.
Sphinx-Gallery makes the generated notebook/source downloads convenient, but some demonstrations depend on repository data files, optional packages, generated assets, or external downloads that are not present in every generated archive. This can leave a locally downloaded demo looking self-contained when it is not.
The issue discussion already suggested adding guidance alongside the demonstration downloads so users know to check the full demo page and obtain the additional resources. This change adds that guidance to the demonstrations gallery introduction.
Change
The demonstrations landing page now:
AIS_Solent_Tracker,OpenSky_Demo, andUAV_tutorial;folium, which is available through the development extra;Video_Processingusers to thevideoandultralyticsextras;This complements #1051, which added the OpenSky CSV/icon links, by providing the gallery-level guidance suggested in the discussion on #1050.
Scope
Documentation only. The Sphinx-Gallery archive generation itself is unchanged.
Closes #1050