Skip to content

Commit 7515ffb

Browse files
authored
Merge pull request #100 from Brain-Modulation-Lab/feat/improving-readthedocs
Feat/improving readthedocs
2 parents 8df4f3d + d4866c5 commit 7515ffb

30 files changed

Lines changed: 761 additions & 124 deletions

.github/workflows/docs-screenshots.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ jobs:
2626
libegl1 \
2727
libgl1 \
2828
libxkbcommon0 \
29-
libdbus-1-3
29+
libdbus-1-3 \
30+
fontconfig \
31+
fonts-dejavu-core
3032
3133
- name: Sync dev dependencies
3234
run: |
@@ -35,7 +37,8 @@ jobs:
3537
- name: Generate screenshot artifacts
3638
env:
3739
QT_QPA_PLATFORM: offscreen
38-
DOCS_SCREENSHOT_DIR: docs/_build/screenshots
40+
DOCS_SCREENSHOT_DIR: docs/_static
41+
# Offscreen on Linux: theme helper swaps QSS to DejaVu Sans (see screenshot_helpers).
3942
run: |
4043
uv run pytest tests/docs/test_docs_screenshots.py -m docs_screenshot
4144

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

88
## [Unreleased]
9+
10+
### Changed
11+
12+
- Read the Docs user guide aligned with current clinical and session scale presets
13+
(OCD, MDD, PD, ET, Dystonia, TS), 0–10 session scales, and report export options
14+
(Session Data graph and table, longitudinal clinical/session timeline charts).
15+
- Documentation copyright updated for Massachusetts General Hospital, Wyss Center
16+
for Bio and Neuroengineering, and Charité Universitätsmedizin Berlin; contact
17+
remains lucia.poma@wysscenter.ch.
18+
919
## [0.4.0b1] - 2026-05-08
1020

1121
### Changed

docs/_static/annotations_list.png

30.9 KB
Loading

docs/_static/annotations_view.png

28 KB
Loading

docs/_static/electrode-canvas.png

30.4 KB
Loading

docs/_static/electrode_diagram.png

30.4 KB
Loading

docs/_static/home_screen.png

22.8 KB
Loading

docs/_static/logo.png

57.4 KB
Loading
42.1 KB
Loading

docs/_static/longitudinal_view.png

36.2 KB
Loading

0 commit comments

Comments
 (0)