Skip to content

Refine dataset docs overview cards and summary pages#1025

Merged
bruAristimunha merged 9 commits intodevelopfrom
feedback-katie
Mar 6, 2026
Merged

Refine dataset docs overview cards and summary pages#1025
bruAristimunha merged 9 commits intodevelopfrom
feedback-katie

Conversation

@bruAristimunha
Copy link
Copy Markdown
Collaborator

Summary

  • move dataset page views into the Citation & Impact card and drop PapersWithCode links from summary tables
  • add the expandable Overview teaser and keep its dataset-page links stable with regression coverage
  • clean up dataset summary reST markup so the docs build without the summary-page warning

Validation

  • pre-commit run --files docs/source/sphinxext/dataset_timeline_ext.py docs/source/dataset_summary.rst moabb/tests/test_dataset_timeline_ext.py
  • pytest moabb/tests/test_dataset_timeline_ext.py moabb/tests/test_datasets.py -k "docstring or completeness or metadata_docstring_sections or timeline_ext"
  • python -m sphinx -D plot_gallery=0 -b html docs/source /tmp/moabb-docs-dataset-fix-noplot

@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

Remove the standalone Page Views section from above Class Labels and
merge it as a single rich row inside the Citation & Impact card.
The new row uses a mini two-column grid (metrics text + sparkline)
that stays consistent with the existing label/value pattern.
- Remove PapersWithCode column from summary CSVs, base.py, docs
- Add collapsible Overview teaser panel between buttons and quickstart
  in the dataset snapshot card, showing the first ~800 chars of the
  docstring with reST-to-HTML formatting (bold, lists, code)
- "Show more" expands full description; "Open in Overview tab" scrolls
  to and activates the Overview tab below
…riable

- Compile _RST_INLINE_RE, _RST_FOOTNOTE_RE, _RST_LIST_SPLIT_RE at module
  level instead of inside per-call functions
- Add --ds-font-mono custom property and replace 9 occurrences of the
  inline monospace font stack
The global autodoc_default_options {"inherited-members": False} was
silently overriding the per-directive :inherited-members: option injected
by the source_read hook. Sphinx's option merging always replaces
directive-level values with boolean global defaults, so the hook had no
effect. Removing the redundant setting fixes it — Sphinx already hides
inherited members by default when the option is absent.

Also adds :show-inheritance: to display the "Bases: ..." line.
Switch table-layout from fixed to auto and remove the hard 36% first-column
width on screens narrower than 768px so columns size to content instead of
overlapping.
BDF is not a valid format for the EEG datatype in the BIDS
specification. The BIDS validator rejects .bdf files with
"Not allowed for EEG datatype".
@bruAristimunha bruAristimunha merged commit e469b96 into develop Mar 6, 2026
14 checks passed
@bruAristimunha bruAristimunha deleted the feedback-katie branch March 6, 2026 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant