Skip to content

Commit f0e1d4b

Browse files
authored
Merge pull request #106 from Brain-Modulation-Lab/feat/improving-readthedocs
Feat/improving readthedocs
2 parents 7515ffb + 6dc8e31 commit f0e1d4b

35 files changed

Lines changed: 648 additions & 262 deletions

CHANGELOG.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Added
11+
12+
- 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.
17+
1018
### Changed
1119

1220
- Read the Docs user guide aligned with current clinical and session scale presets
1321
(OCD, MDD, PD, ET, Dystonia, TS), 0–10 session scales, and report export options
1422
(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).
1535
- Documentation copyright updated for Massachusetts General Hospital, Wyss Center
1636
for Bio and Neuroengineering, and Charité Universitätsmedizin Berlin; contact
1737
remains lucia.poma@wysscenter.ch.

docs/_generated/tsv_schema.inc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Programming session TSV columns
2121
* - ``timezone``
2222
- string
2323
- Timezone abbreviation/offset at capture time.
24-
* - ``block_id``
24+
* - ``block_ID``
2525
- integer
2626
- Index of the stimulation block within a session.
2727
* - ``session_ID``

docs/_static/annotations_view.png

-375 Bytes
Loading
21 KB
Loading

docs/_static/custom.css

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/*
2+
* sphinx-rtd-theme caps main content at ~800px for readability.
3+
* Override so clinical screenshots and wide tables use the full viewport.
4+
*/
5+
.wy-nav-content {
6+
max-width: none;
7+
}
8+
9+
.wy-nav-content-wrap {
10+
max-width: 100%;
11+
}

docs/_static/home_screen.png

53 Bytes
Loading

docs/_static/home_screen_dark.png

22.6 KB
Loading
23.9 KB
Loading

docs/_static/step0.png

56 Bytes
Loading

docs/_static/step1.png

54 Bytes
Loading

0 commit comments

Comments
 (0)