Skip to content

Commit 9fc3369

Browse files
committed
Refresh documentation screenshots for the night theme
Regenerate 110 GUI captures, centralize tutorial references, and retire historical interface assets. Preserve original case-study measurements as lossless crops with source provenance. Extend the existing CaptureSpec registry and popup/controller paths for menus and tutorials. Selected popup captures now overwrite existing files; dropdown captures preserve transient stacking. Application runtime code is unchanged. Validation: all captures completed on Linux/Xvfb; visual image and rendered-page review; 134 local image references resolve; 13 source crops are pixel-exact; clean Sphinx build matches baseline warning set; Ruff, Black 22.10, syntax, and whitespace checks pass.
1 parent 62ea250 commit 9fc3369

258 files changed

Lines changed: 721 additions & 250 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/AGENTS.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,12 @@ conda run -n navigate python docs/capture_gui.py --list
130130

131131
- Key selectors:
132132
- `--all`
133-
- `--group <group>`
133+
- `--group <group>` (including `menus` and `tutorials`)
134134
- `--capture <id>`
135135
- `--manifest <json>`
136136
- `--configurator-only` (compatibility shortcut)
137+
- Selected captures overwrite existing files, including popup screenshots.
138+
- For full unattended captures, use Linux/X11 with Xvfb; see `docs/SCREENSHOTS.rst`.
137139
- The capture path expects `mss` in docs dependencies; do not add a PIL fallback.
138140
- For UI pages that are not fully rendered, increase settle timing:
139141
- `--passes <n>`

‎docs/SCREENSHOTS.rst‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
Refreshing documentation screenshots
2+
====================================
3+
4+
Run the capture script from the repository root with the Navigate environment
5+
and documentation dependencies installed::
6+
7+
python docs/capture_gui.py --list
8+
python docs/capture_gui.py --all
9+
10+
All selected captures replace their previous files, including popups. The
11+
``menus`` and ``tutorials`` groups cover the menu walkthrough and the feature,
12+
multicamera, and ilastik examples. Use ``--group``, ``--capture``, or ``--manifest``
13+
for a smaller refresh. Outputs belong in ``docs/source/images/``; tutorial pages
14+
should reference these shared images instead of keeping local copies.
15+
16+
For a complete unattended capture, use Linux with an X11 virtual display::
17+
18+
xvfb-run -a -s "-screen 0 3200x2200x24" \
19+
python docs/capture_gui.py --all --passes 3 --delay-ms 100
20+
21+
The script uses synthetic hardware and illustrative settings. It does not run
22+
an experiment. Use a disposable user profile when installed plugins or personal
23+
configuration could affect screenshots. Native macOS menus can block Tk's event
24+
loop or expose no capturable bounds; capture menus on X11. On an interactive
25+
desktop, keep other windows and system overlays away during capture.
26+
27+
Review every generated image for clipping, blank controls, or overlapping
28+
windows. Then build the documentation::
29+
30+
conda run -n navigate make -C docs html -j 15
31+
32+
Check image references throughout ``docs/source/``, including case studies and
33+
contributor tutorials, and remove unused historical GUI images. A successful
34+
capture run alone does not verify that every documentation page uses it.
35+
36+
Preserved case-study results
37+
---------------------------
38+
39+
``source/images/case-studies/`` contains the original beam and tissue images,
40+
autofocus plots, segmentation result, and CSV example with historical GUI
41+
chrome removed. These are lossless crops, not new measurements or simulations.
42+
``case_study_image_sources.json`` records the source commit, original file, and
43+
crop bounds so each image can be reproduced from Git history. Do not replace
44+
experimental results with synthetic screenshots when refreshing the interface.

0 commit comments

Comments
 (0)