Skip to content

Commit 3c7b7e0

Browse files
authored
Merge pull request #107 from Brain-Modulation-Lab/feat/improving-readthedocs
rtd updates
2 parents f0e1d4b + dd98f9a commit 3c7b7e0

32 files changed

Lines changed: 256 additions & 188 deletions

CHANGELOG.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,31 +10,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
### Added
1111

1212
- Read the Docs screenshot pipeline: home screen (light and dark theme), clinical
13-
scales settings dialog, and session scales settings dialog (draft preset fields,
14-
not persisted during capture).
15-
- ``docs/_static/custom.css`` so RTD content uses the full viewport width instead
16-
of the theme default narrow column.
13+
and session scales settings dialogs, and regenerated workflow captures at
14+
native resolution (HiDPI-aware screen grab, improved PNG settings).
15+
- ``docs/_static/custom.css``: full-width RTD content; ``screenshot-full`` (wizard
16+
steps) and ``screenshot-medium`` (home, dialogs) with ``max-width: 720px`` to
17+
avoid upscaled blurry dialog images.
18+
- ``COPYRIGHT_HOLDERS`` and ``APP_LICENSE_NAME`` in ``config.py`` (shared with
19+
documentation).
1720

1821
### Changed
1922

20-
- Read the Docs user guide aligned with current clinical and session scale presets
21-
(OCD, MDD, PD, ET, Dystonia, TS), 0–10 session scales, and report export options
22-
(Session Data graph and table, longitudinal clinical/session timeline charts).
23-
- ``docs/installation.rst`` and updating section aligned with README end-user install
24-
commands (GitHub Releases ``.msi`` / ``.dmg`` / ``.deb``, PowerShell and shell
25-
one-liners, in-app update checker).
26-
- Workflow documentation renamed for consistency with the home screen:
27-
**Complete Workflow** (formerly “Session Workflow”) and **Annotation-only Workflow**
28-
(formerly “Free Annotations”); quickstart and index updated accordingly.
29-
- ``docs/workflow_session.rst``: Step 1 and Step 2 sections document per-session scale
30-
rows (**** / **+**), score-only TSV persistence for clinical scales, min/max ranges
31-
for session scales, and permanent preset editing via **settings** (including
32-
``Name:min-max`` format for session presets).
33-
- Home screen buttons relabelled to **Complete Workflow** and **Annotations-only
34-
Workflow** (capital W).
35-
- Documentation copyright updated for Massachusetts General Hospital, Wyss Center
36-
for Bio and Neuroengineering, and Charité Universitätsmedizin Berlin; contact
37-
remains lucia.poma@wysscenter.ch.
23+
- **Help** dialog rewritten around the standard **Complete Workflow** programming
24+
pipeline, timestamped ``task-programming`` TSV output, and Word/PDF reports;
25+
copyright lists MGH, Wyss Center, and Charité; MIT license noted.
26+
- Annotations-only file step header title: **Clinical Annotations Setup** (was
27+
"Output File").
28+
- Home screen buttons: **Complete Workflow** and **Annotations-only Workflow**.
29+
- Read the Docs: installation aligned with README; workflow pages renamed
30+
(**Complete Workflow**, **Annotation-only Workflow**); ``workflow_session.rst``
31+
documents per-session scales (**** / **+**, settings dialogs);
32+
``longitudinal_report.rst`` and ``quickstart.rst`` specify ``task-programming``
33+
BIDS files for longitudinal reports.
34+
- Documentation copyright: Massachusetts General Hospital, Wyss Center for Bio
35+
and Neuroengineering, and Charité Universitätsmedizin Berlin.
3836

3937
## [0.4.0b1] - 2026-05-08
4038

docs/_static/annotations_list.png

-3.38 KB
Loading

docs/_static/annotations_view.png

752 Bytes
Loading
511 Bytes
Loading

docs/_static/custom.css

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,19 @@
99
.wy-nav-content-wrap {
1010
max-width: 100%;
1111
}
12+
13+
/* Full application window (wizard steps, session views). */
14+
.rst-content img.screenshot-full,
15+
.wy-nav-content img.screenshot-full {
16+
width: 100% !important;
17+
max-width: 100%;
18+
height: auto;
19+
}
20+
21+
/* Home screen, settings dialogs, and other modal / partial captures. */
22+
.rst-content img.screenshot-medium,
23+
.wy-nav-content img.screenshot-medium {
24+
width: 60% !important;
25+
max-width: 720px;
26+
height: auto;
27+
}

docs/_static/electrode-canvas.png

29.6 KB
Loading

docs/_static/electrode_diagram.png

29.6 KB
Loading

docs/_static/home_screen.png

8.83 KB
Loading

docs/_static/home_screen_dark.png

8.85 KB
Loading
-1.26 KB
Loading

0 commit comments

Comments
 (0)