[DOC] Improving the API Documentation #145
Merged
Conversation
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
This commit introduces a new user guide for the eegdash library, inspired by the documentation of scipy and scikit-learn. The user guide (`docs/source/user_guide.rst`) provides a comprehensive overview of the `EEGDash` and `EEGDashDataset` objects, explaining how to: - Initialize both objects. - Query for data using simple filters and advanced MongoDB-style queries. - Use the library in offline mode with local data. - Access and load EEG data from the dataset. The guide includes numerous code snippets to illustrate the functionality. Additionally, this commit includes the following changes to support the documentation build: - Added the `sphinx.ext.graphviz` extension to `docs/source/conf.py`. - Fixed formatting issues in `examples/eeg2025/tutorial_challenge_1.py` to resolve build errors.
feat: Create user guide for eegdash
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.