Skip to content

Commit 517adf4

Browse files
authored
Merge pull request #129 from Brain-Modulation-Lab/feat/setting_presets_btns
rtd style
2 parents a86e85e + 7f59592 commit 517adf4

14 files changed

Lines changed: 88 additions & 145 deletions

CHANGELOG.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1717

1818
### Changed
1919

20-
- Read the Docs: dark content panel and prose styling; screenshots and figures capped
21-
at 60% width (centered) via ``docs/_static/custom.css``.
20+
- Read the Docs: standard sphinx-rtd-theme palette (dark grey sidebar frame,
21+
light content panel, default blue links/headings); explicit table/body text
22+
contrast on the light panel; screenshots and figures capped at 60% width
23+
(centered) via ``docs/_static/custom.css``.
24+
- Docs screenshot pipeline: wizard captures use 60% of the app's normal step window
25+
size (``WIZARD_SCREENSHOT_SIZE_RATIO`` in ``tests/docs/screenshot_helpers.py``)
26+
for denser, balanced full-window PNGs on RTD.
2227

2328
### Fixed
2429

30+
- In-app **Update now** on Windows: download ``install.ps1`` into a stable folder
31+
(``%TEMP%\dbs_annotator_update\``) instead of a short-lived temp file deleted
32+
immediately after launch, so PowerShell can run the script (fixes flash-and-close
33+
with no install when upgrading, e.g. from ``0.4.0b2`` to ``0.4.0``); pause the
34+
console when the installer fails so the error stays visible.
2535
- Dependency audit: pin ``uv>=0.11.15`` (GHSA-4gg8-gxpx-9rph); upgrade ``pip`` to
2636
26.1.2 (PYSEC-2026-196, Briefcase transitive dep).
2737

@@ -51,9 +61,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5161

5262
### Fixed
5363

54-
- In-app **Update now** on Windows: keep the install script on disk until PowerShell
55-
finishes (avoids a flash-and-close with no install) and pause the console when
56-
the installer fails so the error message stays visible.
5764
- Step 1 clinical preset buttons disappearing after adding a preset in settings
5865
(horizontal scroll strip sizing).
5966
- Step 3 session settings: external vertical scrollbar column (same layout as Step 1;

docs/_static/annotations_list.png

-15.6 KB
Loading

docs/_static/annotations_view.png

-16 KB
Loading

docs/_static/custom.css

Lines changed: 41 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,33 @@
11
/*
22
* DBS Annotator Read the Docs overrides (sphinx-rtd-theme).
3-
* Dark content panel; screenshots capped at 60% of the prose column.
3+
* Keep standard RTD colours (dark sidebar, light content, blue links/headings);
4+
* widen the prose column; cap screenshots at 60%.
45
*/
56
:root {
6-
/* Match sphinx-rtd-theme sidebar (.wy-nav-side). */
7-
--dbs-docs-canvas: #343131;
8-
--dbs-docs-panel: #1e293b;
9-
--dbs-docs-panel-text: #f1f5f9;
10-
--dbs-docs-muted: #94a3b8;
11-
--dbs-docs-border: #475569;
12-
--dbs-docs-link: #fbbf24;
13-
--dbs-docs-link-hover: #f59e0b;
14-
--dbs-docs-code-bg: #334155;
15-
--dbs-docs-code-text: #e2e8f0;
16-
--dbs-docs-admonition-bg: #334155;
7+
/* sphinx-rtd-theme .wy-nav-side */
8+
--dbs-docs-sidebar: #343131;
9+
/* sphinx-rtd-theme .wy-nav-content-wrap / content area */
10+
--dbs-docs-content-bg: #fcfcfc;
1711
--dbs-docs-screenshot-max: 60%;
1812
}
1913

20-
/* Dark outer canvas (same tone as the left navigation column). */
21-
/* !important beats theme.css (.wy-nav-content-wrap { background: #fcfcfc }). */
14+
/* Outer area — same dark grey as the left navigation column (standard RTD). */
2215
html,
2316
body.wy-body-for-nav,
2417
.wy-body-for-nav,
2518
.wy-grid-for-nav,
2619
section.wy-nav-content-wrap,
2720
.wy-nav-content-wrap {
28-
background: var(--dbs-docs-canvas) !important;
29-
background-color: var(--dbs-docs-canvas) !important;
21+
background: var(--dbs-docs-sidebar) !important;
22+
background-color: var(--dbs-docs-sidebar) !important;
3023
}
3124

32-
/* Main prose column — dark panel. */
25+
/* Main prose column — standard RTD light panel (not app dark theme). */
3326
.wy-nav-content {
3427
max-width: none !important;
35-
background: var(--dbs-docs-panel) !important;
36-
background-color: var(--dbs-docs-panel) !important;
37-
color: var(--dbs-docs-panel-text);
38-
box-shadow: 0 0 24px rgba(0, 0, 0, 0.45);
28+
background: var(--dbs-docs-content-bg) !important;
29+
background-color: var(--dbs-docs-content-bg) !important;
30+
box-shadow: 0 0 20px rgba(0, 0, 0, 0.2);
3931
margin-inline: clamp(0px, 2.5vw, 40px);
4032
min-height: 100%;
4133
}
@@ -44,141 +36,53 @@ section.wy-nav-content-wrap,
4436
max-width: 100%;
4537
}
4638

47-
/* Breadcrumbs & page chrome on the dark canvas (outside the content panel). */
48-
.wy-nav-content-wrap .wy-breadcrumbs li,
49-
.wy-nav-content-wrap .wy-breadcrumbs li a {
50-
color: var(--dbs-docs-muted);
51-
}
52-
53-
.wy-nav-content-wrap .wy-breadcrumbs li a:hover {
54-
color: var(--dbs-docs-link-hover);
55-
}
56-
57-
.wy-nav-content-wrap .wy-breadcrumbs li.wy-breadcrumbs-aside {
58-
color: var(--dbs-docs-panel-text);
59-
}
60-
61-
.wy-nav-content-wrap footer,
62-
.wy-nav-content-wrap footer span,
63-
.wy-nav-content-wrap .rst-footer-buttons {
64-
color: var(--dbs-docs-muted);
65-
}
66-
67-
.wy-nav-content-wrap footer a {
68-
color: var(--dbs-docs-link);
69-
}
70-
71-
/* ---- Typography & prose (dark) ---- */
39+
/*
40+
* Prose on the light panel — pin body colour so it does not inherit from the
41+
* dark outer wrap (tables/list-tables were unreadable when text stayed pale).
42+
*/
7243
.wy-nav-content .rst-content {
73-
color: var(--dbs-docs-panel-text);
74-
}
75-
76-
.wy-nav-content .rst-content h1,
77-
.wy-nav-content .rst-content h2,
78-
.wy-nav-content .rst-content h3,
79-
.wy-nav-content .rst-content h4,
80-
.wy-nav-content .rst-content h5,
81-
.wy-nav-content .rst-content h6 {
82-
color: #ffffff;
83-
}
84-
85-
.wy-nav-content .rst-content a {
86-
color: var(--dbs-docs-link);
87-
}
88-
89-
.wy-nav-content .rst-content a:hover {
90-
color: var(--dbs-docs-link-hover);
91-
}
92-
93-
.wy-nav-content .rst-content p,
94-
.wy-nav-content .rst-content li,
95-
.wy-nav-content .rst-content td,
96-
.wy-nav-content .rst-content th {
97-
color: var(--dbs-docs-panel-text);
98-
}
99-
100-
.wy-nav-content .rst-content .caption-text,
101-
.wy-nav-content .rst-content .legend,
102-
.wy-nav-content .rst-content .figure .caption {
103-
color: var(--dbs-docs-muted);
104-
}
105-
106-
.wy-nav-content .rst-content hr {
107-
border-color: var(--dbs-docs-border);
108-
}
109-
110-
.wy-nav-content .rst-content blockquote {
111-
border-left-color: var(--dbs-docs-link);
112-
background: var(--dbs-docs-code-bg);
113-
color: var(--dbs-docs-panel-text);
114-
}
115-
116-
/* Inline and block code */
117-
.wy-nav-content .rst-content code,
118-
.wy-nav-content .rst-content code.literal {
119-
background: var(--dbs-docs-code-bg);
120-
color: var(--dbs-docs-code-text);
121-
border: 1px solid var(--dbs-docs-border);
122-
}
123-
124-
.wy-nav-content .rst-content pre,
125-
.wy-nav-content .rst-content .highlight {
126-
background: var(--dbs-docs-code-bg) !important;
127-
border: 1px solid var(--dbs-docs-border);
128-
}
129-
130-
.wy-nav-content .rst-content .highlight pre {
131-
color: var(--dbs-docs-code-text);
44+
color: #404040;
13245
}
13346

134-
/* Tables */
13547
.wy-nav-content .rst-content table.docutils,
13648
.wy-nav-content .wy-table-responsive table {
137-
background: var(--dbs-docs-code-bg);
138-
border-color: var(--dbs-docs-border);
49+
color: #404040;
50+
border-color: #e1e4e5;
13951
}
14052

14153
.wy-nav-content .rst-content table.docutils th,
14254
.wy-nav-content .wy-table-responsive table thead th {
143-
background: #0f172a;
144-
color: #ffffff;
145-
border-color: var(--dbs-docs-border);
55+
background-color: #f3f6f6;
56+
color: #404040;
57+
border-color: #e1e4e5;
14658
}
14759

14860
.wy-nav-content .rst-content table.docutils td,
14961
.wy-nav-content .wy-table-responsive table td {
150-
border-color: var(--dbs-docs-border);
151-
color: var(--dbs-docs-panel-text);
152-
}
153-
154-
/* Admonitions (note, tip, warning, …) */
155-
.wy-nav-content .rst-content .admonition {
156-
background: var(--dbs-docs-admonition-bg);
157-
border-color: var(--dbs-docs-border);
158-
color: var(--dbs-docs-panel-text);
62+
background-color: #ffffff;
63+
color: #404040;
64+
border-color: #e1e4e5;
15965
}
16066

161-
.wy-nav-content .rst-content .admonition .admonition-title {
162-
background: #0f172a;
163-
color: #ffffff;
67+
.wy-nav-content .rst-content table.docutils tr:nth-child(2n) td,
68+
.wy-nav-content .wy-table-responsive table tr:nth-child(2n) td {
69+
background-color: #f3f6f6;
16470
}
16571

166-
.wy-nav-content .rst-content .note .admonition-title {
167-
background: #1e3a5f;
168-
}
169-
170-
.wy-nav-content .rst-content .warning .admonition-title {
171-
background: #7c2d12;
72+
/* Breadcrumbs sit on the dark canvas, outside the light panel. */
73+
.wy-nav-content-wrap .wy-breadcrumbs li,
74+
.wy-nav-content-wrap .wy-breadcrumbs li a {
75+
color: #b3b3b3;
17276
}
17377

174-
.wy-nav-content .rst-content .tip .admonition-title {
175-
background: #14532d;
78+
.wy-nav-content-wrap .wy-breadcrumbs li a:hover {
79+
color: #ffffff;
17680
}
17781

178-
/* Footer inside content */
179-
.wy-nav-content .rst-footer-buttons,
180-
.wy-nav-content footer {
181-
color: var(--dbs-docs-muted);
82+
.wy-nav-content-wrap footer,
83+
.wy-nav-content-wrap footer span,
84+
.wy-nav-content-wrap .rst-footer-buttons {
85+
color: #b3b3b3;
18286
}
18387

18488
/* ---- Screenshots & figures (max 60% width, centered) ---- */
@@ -195,8 +99,8 @@ section.wy-nav-content-wrap,
19599
max-width: var(--dbs-docs-screenshot-max);
196100
height: auto;
197101
margin-inline: auto;
198-
border-radius: 6px;
199-
box-shadow: 0 4px 18px rgba(0, 0, 0, 0.45);
102+
border-radius: 4px;
103+
box-shadow: 0 2px 12px rgba(0, 0, 0, 0.12);
200104
}
201105

202106
/* Home-page logo keeps its explicit :width: from RST. */

docs/_static/home_screen.png

-297 Bytes
Loading

docs/_static/home_screen_dark.png

-378 Bytes
Loading
-16.7 KB
Loading

docs/_static/longitudinal_view.png

-16.1 KB
Loading

docs/_static/step0.png

-38.4 KB
Loading

docs/_static/step1.png

-43 KB
Loading

0 commit comments

Comments
 (0)