Skip to content

Commit a86e85e

Browse files
authored
Merge pull request #128 from Brain-Modulation-Lab/feat/setting_presets_btns
Feat/setting presets btns
2 parents be63f3b + 1127807 commit a86e85e

37 files changed

Lines changed: 1140 additions & 151 deletions

CHANGELOG.md

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

88
## [Unreleased]
99

10+
### Added
11+
12+
- Step 1: preset combo boxes for frequency, amplitude, and pulse width on left and
13+
right stimulation rows; gear button edits preset lists (stored in
14+
``setting_presets.json``).
15+
- Documentation screenshots for **Edit Setting Presets** and **Edit Program Names**
16+
dialogs on Step 1.
17+
18+
### Changed
19+
20+
- Read the Docs: dark content panel and prose styling; screenshots and figures capped
21+
at 60% width (centered) via ``docs/_static/custom.css``.
22+
1023
### Fixed
1124

1225
- Dependency audit: pin ``uv>=0.11.15`` (GHSA-4gg8-gxpx-9rph); upgrade ``pip`` to

docs/_static/annotations_list.png

23.1 KB
Loading

docs/_static/annotations_view.png

21.8 KB
Loading
3.92 KB
Loading

docs/_static/custom.css

Lines changed: 178 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,207 @@
11
/*
2-
* sphinx-rtd-theme caps main content at ~800px for readability.
3-
* Override so clinical screenshots and wide tables use the full viewport.
2+
* DBS Annotator Read the Docs overrides (sphinx-rtd-theme).
3+
* Dark content panel; screenshots capped at 60% of the prose column.
44
*/
55
:root {
66
/* Match sphinx-rtd-theme sidebar (.wy-nav-side). */
77
--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;
17+
--dbs-docs-screenshot-max: 60%;
818
}
919

1020
/* Dark outer canvas (same tone as the left navigation column). */
21+
/* !important beats theme.css (.wy-nav-content-wrap { background: #fcfcfc }). */
1122
html,
12-
body,
23+
body.wy-body-for-nav,
1324
.wy-body-for-nav,
1425
.wy-grid-for-nav,
26+
section.wy-nav-content-wrap,
1527
.wy-nav-content-wrap {
16-
background: var(--dbs-docs-canvas);
28+
background: var(--dbs-docs-canvas) !important;
29+
background-color: var(--dbs-docs-canvas) !important;
1730
}
1831

19-
/* Readable "window" for prose, screenshots, and tables. */
32+
/* Main prose column — dark panel. */
2033
.wy-nav-content {
21-
max-width: none;
22-
background: #ffffff;
23-
box-shadow: 0 0 18px rgba(0, 0, 0, 0.28);
34+
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);
39+
margin-inline: clamp(0px, 2.5vw, 40px);
40+
min-height: 100%;
2441
}
2542

2643
.wy-nav-content-wrap {
2744
max-width: 100%;
2845
}
2946

30-
/* Full application window (wizard steps, session views). */
31-
.rst-content img.screenshot-full,
32-
.wy-nav-content img.screenshot-full {
33-
width: 100% !important;
34-
max-width: 100%;
35-
height: auto;
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);
3651
}
3752

38-
/*
39-
* Dialogs, home screen, and other partial captures.
40-
* Never upscale beyond the PNG's intrinsic width; shrink only on narrow viewports.
41-
*/
42-
.rst-content img.screenshot-native,
43-
.wy-nav-content img.screenshot-native {
44-
width: auto !important;
45-
max-width: 100%;
46-
height: auto;
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) ---- */
72+
.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);
132+
}
133+
134+
/* Tables */
135+
.wy-nav-content .rst-content table.docutils,
136+
.wy-nav-content .wy-table-responsive table {
137+
background: var(--dbs-docs-code-bg);
138+
border-color: var(--dbs-docs-border);
139+
}
140+
141+
.wy-nav-content .rst-content table.docutils th,
142+
.wy-nav-content .wy-table-responsive table thead th {
143+
background: #0f172a;
144+
color: #ffffff;
145+
border-color: var(--dbs-docs-border);
146+
}
147+
148+
.wy-nav-content .rst-content table.docutils td,
149+
.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);
47159
}
48160

49-
/* Back-compat alias (older docs / branches). */
161+
.wy-nav-content .rst-content .admonition .admonition-title {
162+
background: #0f172a;
163+
color: #ffffff;
164+
}
165+
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;
172+
}
173+
174+
.wy-nav-content .rst-content .tip .admonition-title {
175+
background: #14532d;
176+
}
177+
178+
/* Footer inside content */
179+
.wy-nav-content .rst-footer-buttons,
180+
.wy-nav-content footer {
181+
color: var(--dbs-docs-muted);
182+
}
183+
184+
/* ---- Screenshots & figures (max 60% width, centered) ---- */
185+
.rst-content img.screenshot-full,
186+
.rst-content img.screenshot-native,
50187
.rst-content img.screenshot-medium,
51-
.wy-nav-content img.screenshot-medium {
188+
.rst-content .figure img,
189+
.wy-nav-content img.screenshot-full,
190+
.wy-nav-content img.screenshot-native,
191+
.wy-nav-content img.screenshot-medium,
192+
.wy-nav-content .figure img {
193+
display: block;
52194
width: auto !important;
53-
max-width: 100%;
195+
max-width: var(--dbs-docs-screenshot-max);
54196
height: auto;
197+
margin-inline: auto;
198+
border-radius: 6px;
199+
box-shadow: 0 4px 18px rgba(0, 0, 0, 0.45);
200+
}
201+
202+
/* Home-page logo keeps its explicit :width: from RST. */
203+
.rst-content img[src*="logo.png"],
204+
.wy-nav-content img[src*="logo.png"] {
205+
max-width: none;
206+
box-shadow: none;
55207
}

docs/_static/home_screen.png

4.28 KB
Loading

docs/_static/home_screen_dark.png

3.94 KB
Loading
25.7 KB
Loading

docs/_static/longitudinal_view.png

23.8 KB
Loading
9.75 KB
Loading

0 commit comments

Comments
 (0)