Build standalone EEGPrep Sphinx manual and tutorials - #172
Merged
suraj-ranganath merged 4 commits intoJun 7, 2026
Merged
Conversation
|
Claude encountered an error after 0s —— View job I'll analyze this and get back to you. |
suraj-ranganath
changed the title
This was referenced Jun 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reorganizes EEGPrep's Sphinx docs into a standalone user manual with sample_data quickstarts, shared GUI plus eegprep-console workflows, scripting tutorials, MNE integration, bundled plugin notes, migration guidance, refreshed styling, generated API pages, and missing pop_* help resources.
This update also adds contributor/skill guidance requiring future user-facing EEGPrep changes to update Sphinx docs and packaged help resources, cleans generated/API doc ownership so cold Sphinx builds are warning-free, and includes docstring-only cleanup for public APIs whose generated docs previously rendered with autodoc/docutils warnings. No EEG processing behavior changed.
Follow-up review cleanup fixed stale manual pages that still described older object-style APIs, corrected BIDS workflow examples to the implemented
pop_load_frombids/bids_list_eeg_files/bids_preproc/pop_exportbidsAPIs, clarified plugin inventory access throughsession.PLUGINLIST, and fixed broken internal/external documentation links found by Sphinx linkcheck.Closes #164
Closes #22