Update docs#1189
Merged
Merged
Conversation
Update copyright headers across the codebase from 2025 to 2026. Also apply a set of small, mainly non-functional cleanups: reformat long lines and comprehensions, normalize dict/list formatting, add missing trailing commas, tidy imports and string quoting in menus, and minor expression simplifications (e.g. tiling overlay). Several test package __init__.py files were added and many tests were updated accordingly. No major logic changes intended.
Rename beginner.rst to acquiring_data.rst and refactor the acquiring-data guide: simplify environment/launch instructions, add guidance for Virtual Devices (synthetic hardware), update image paths, and clarify stage control wording. Add multiple UI screenshots to docs/source/images (MainApp, Camera/Channels/Stage tabs, channel selector images, configurator, etc.). Also add the "mss" package to pyproject.toml dependencies used for the docs.
Reorganize and expand the documentation and tooling for the getting-started flow and documentation screenshots. Add docs/AGENTS.md with authoring guidelines and expectations for contributors and automated agents. Replace the old docs/capture_gui.py with an executable, CLI-driven capture tool (manifest/grouping, settle/delay options, configurator support, robust context build/teardown, and reusable capture specs) that writes screenshots to docs/source/images. Restructure Getting Started content: remove the old quick_start page and legacy software_installation, add new pages for minimum system requirements, software installation (strategies: Conda/venv/uv/GitHub), launching navigate, and configuring navigate; also move and edit the power management page into the getting-started section. Remove obsolete images and update references in software_configuration.rst accordingly. These changes improve doc organization, clarity for new users, and reproducible screenshot capture for docs maintenance.
Improve screenshot capture and refresh docs. Make settle_window ensure the Tk root is visible/topmost before capturing. Add _capture_combobox_dropdown helper and refactor existing combobox capture to use it; add new capture runners for sensor-mode and ROI-definition and register them in CAPTURES. Update getting-started RST to center-align images, fix image paths, and add new sensor-mode.png and ROI-definition.png (and refresh several other doc screenshots). These changes make dropdown screenshots more reliable and update the documentation visuals.
Move and consolidate documentation screenshots, update rst references, and enhance the GUI capture tooling. AGENTS.md gains a "Hardware Docs Conventions" section; many beginner images were removed from their old folder and added under docs/source/images with updated paths in acquiring_data.rst. capture_gui.py was extended with helpers to prepare windows for screenshots (suppress hover tooltips, settle geometry), robust combobox/popdown handling, mode/state helpers, many new capture routines for acquiring-data screenshots, and new entries added to the CAPTURES list. Also small textual edits in camera.rst and a change to pyproject.toml.
Reflow and clean up the Supported File Formats docs for readability and consistency. Added a section anchor and a File Types subsection, normalized RST directives (note::), and introduced subsection adornments (~) for TIFF/BigDataViewer/OME-Zarr blocks. Minor copy edits: reworded timing line to "Median write time reported in milliseconds", updated the OME-Zarr link text to OME-NGFF 0.4, and fixed hard drive size formatting ("7680 GB"). These changes are purely documentation/formatting to improve clarity.
Reorganize documentation layout to separate contributor and user content. Move advanced hardware/how-to pages into a new 'Hardware Integration' section under contributing; add hardware_communication_guidelines, hardware_integration index, code_of_conduct, and code_quality pages; replace legacy intermediate how-to with a new Smart Acquisition Routines guide; update contributing guidelines to reference the new pages and streamline contribution workflow; add developer_install anchor and update docs index to include the new entries. Removed obsolete 03_i_want_to index files and relocated add_new_device/advanced files to the contributing hardware path.
Add numerous capture helper functions to docs/capture_gui.py for feature-list and multiposition examples and register corresponding CaptureSpec entries. Rework docs/source/01_getting_started/07_smart_routines.rst to use the new image locations and clarify the walkthrough text. Update docs/source/conf.py to enable the todo extension (disabled by default). Remove legacy images from docs/source/01_getting_started/... and add consolidated images and several debug screenshots under docs/source/images/.
Add a multi-page User Interface Walkthrough (split into six new rst pages and images) and update the main walkthrough to a toctree. Register the new "Camera Offset and Variance Maps" menu entry in menus.py (and remove a redundant add_command). Add daheng camera to autodoc_mock_imports so docs build, and add smart_microscope_mode: True to the example experiment.yml. Also adjust a camera-settings unit test to safely read exposure_time with a fallback default.
Remove duplicate project.optional-depenencies entry for photometrics...
MultiPositions in the experiment.yml file is now obsolete. Accidentally appended smart_microscope_mode when discussing code, and forgot to remove it. Likewise, same happened with the test_camera_settings file...
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## develop #1189 +/- ##
===========================================
- Coverage 54.43% 54.42% -0.01%
===========================================
Files 191 189 -2
Lines 24795 24778 -17
===========================================
- Hits 13497 13486 -11
+ Misses 11298 11292 -6
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Update the copyright information, and systematically worked my way through a lot of the documentation. It is ~50% updated.