Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
22afd1a
xarray
bruAristimunha Sep 23, 2025
39bf9c9
updating the tests
bruAristimunha Sep 23, 2025
db12175
Merge branch 'develop' into clean_legacy-code
bruAristimunha Sep 27, 2025
3343b49
removing the make file
bruAristimunha Sep 27, 2025
ae359fc
updating
bruAristimunha Sep 27, 2025
0030b9e
first stage, api solved
bruAristimunha Sep 27, 2025
7435d36
updating the api webpage.
bruAristimunha Sep 27, 2025
b8b08d5
improving the api page
bruAristimunha Sep 27, 2025
a154b13
removing lateral sidebar
bruAristimunha Sep 27, 2025
d508ad9
updating names
bruAristimunha Sep 28, 2025
d5bd42e
overview into the api core
bruAristimunha Sep 28, 2025
554f5c3
copy button
bruAristimunha Sep 28, 2025
8c706d3
updating the doc page
bruAristimunha Sep 28, 2025
47e669e
removing the custom.css
bruAristimunha Sep 28, 2025
c42653e
updating the shell
bruAristimunha Sep 28, 2025
b606c26
install button
bruAristimunha Sep 28, 2025
37b8410
improving and stopping
bruAristimunha Sep 28, 2025
7421405
Merge pull request #140 from sccn/clean_legacy-code
bruAristimunha Sep 28, 2025
cdddb6a
updating the name
bruAristimunha Sep 28, 2025
a6572ac
updating install
bruAristimunha Sep 28, 2025
7a75105
updating the api
bruAristimunha Sep 28, 2025
4fd6e18
perfect!
bruAristimunha Sep 28, 2025
b3b2315
updating the api.rst
bruAristimunha Sep 28, 2025
bc613af
fixing small detail
bruAristimunha Sep 28, 2025
380f3b5
Merge branch 'develop' into documentation
bruAristimunha Sep 28, 2025
acd2c0a
updating the api
bruAristimunha Sep 28, 2025
b1bc9ee
Merge branch 'documentation' of https://github.com/sccn/EEGDash into …
bruAristimunha Sep 28, 2025
2bfb043
first round of the dataset page.
bruAristimunha Sep 28, 2025
ca9a5d2
updating the tag separation
bruAristimunha Sep 28, 2025
9b8e6f0
re-order
bruAristimunha Sep 28, 2025
6be16f5
css
bruAristimunha Sep 28, 2025
a7fd0ed
updating the api issue
bruAristimunha Sep 28, 2025
995a441
including all in all the files
bruAristimunha Sep 28, 2025
b570ec5
including execution time too
bruAristimunha Sep 28, 2025
90ed03a
fixing the docs
bruAristimunha Sep 28, 2025
3c8c6bb
updating the make file
bruAristimunha Sep 28, 2025
cba154c
feat: Create user guide for eegdash
google-labs-jules[bot] Sep 28, 2025
e3fabda
reverting mistake
bruAristimunha Sep 28, 2025
2791da7
updating the summary table
bruAristimunha Sep 28, 2025
e59f29f
updating the path
bruAristimunha Sep 28, 2025
3fe9518
first round
bruAristimunha Sep 28, 2025
521c54b
updating the prepare summary table
bruAristimunha Sep 28, 2025
62cce4b
updating the externalization
bruAristimunha Sep 28, 2025
0707019
updating the dataset summary
bruAristimunha Sep 28, 2025
e1dab01
Merge branch 'documentation' into feature/create-user-guide
bruAristimunha Sep 28, 2025
1ec4200
Merge branch 'documentation' into feature/create-user-guide
bruAristimunha Sep 28, 2025
adecdde
Merge pull request #149 from sccn/feature/create-user-guide
bruAristimunha Sep 28, 2025
0a2a871
fixing pre-commit and ignore
bruAristimunha Sep 28, 2025
84f3a77
Merge branch 'documentation' of https://github.com/sccn/EEGDash into …
bruAristimunha Sep 28, 2025
e68449b
fixing the table i hope
bruAristimunha Sep 28, 2025
85bdfb0
updating the python script
bruAristimunha Sep 28, 2025
670d243
pre-commit
bruAristimunha Sep 28, 2025
c6ea321
Merge pull request #145 from sccn/documentation
bruAristimunha Sep 28, 2025
d5b27c5
Merge branch 'main' into develop
bruAristimunha Sep 28, 2025
5bde952
fixing formation again
bruAristimunha Sep 28, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ build/

dist/
docs/build/
docs/source/sg_execution_times.rst
docs/source/gen_modules/
docs/source/generated/
docs/auto_examples/
Expand All @@ -44,3 +43,7 @@ data/
*.json
*.isorted
*.py.isorted

examples/eeg2025/weights*
# Generated dataset visualizations
docs/source/_static/dataset_generated/
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ repos:
- --select=E,W,F,D,NPY201
- --ignore=E402,E501,D100,D101,D102,D103,D104,D105,D107,D205,D400,D415,D417,F403,D401,E741,E722,D419
files: ^(eegdash|docs|notebooks|scripts|tests)/
exclude: \.ipynb$
exclude: (\.ipynb$|docs/prepare_summary_tables\.py$)
- id: ruff
name: ruff examples
args:
Expand Down
591 changes: 591 additions & 0 deletions api_dataset.rst

Large diffs are not rendered by default.

26 changes: 4 additions & 22 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,34 +12,17 @@ help:
.PHONY: apidoc
apidoc:
# Generate full API docs, then prune duplicates covered by autosummary
@python -m sphinx.ext.apidoc -f -e -M -o "$(APIDIR)/dataset" "../$(PKG)"
@SPHINX_APIDOC_OPTIONS=members,undoc-members,show-inheritance,noindex \
python -m sphinx.ext.apidoc -f -e -M -o "$(APIDIR)/dataset" "../$(PKG)"
# Remove top-level package page and modules covered elsewhere
@rm -f "$(APIDIR)/dataset/eegdash.rst"
@rm -f "$(APIDIR)/dataset/eegdash.api.rst"
@rm -f "$(APIDIR)/dataset/eegdash.bids_eeg_metadata.rst"
@rm -f "$(APIDIR)/dataset/eegdash.const.rst"
@rm -f "$(APIDIR)/dataset/eegdash.data_utils.rst"
@rm -f "$(APIDIR)/dataset/eegdash.logging.rst"
@rm -f "$(APIDIR)/dataset/eegdash.mongodb.rst"
@rm -f "$(APIDIR)/dataset/eegdash.paths.rst"
@rm -f "$(APIDIR)/dataset/eegdash.utils.rst"
@rm -f "$(APIDIR)/dataset/eegdash.features.rst"
@rm -f $(APIDIR)/dataset/eegdash.features.*.rst
@rm -f "$(APIDIR)/dataset/eegdash.hbn.rst"
@rm -f $(APIDIR)/dataset/eegdash.hbn.*.rst
@rm -f "$(APIDIR)/dataset/modules.rst"

.PHONY: dataset-pages
dataset-pages:
# Generate individual dataset documentation pages
@python generate_dataset_pages.py

# Standard build runs examples
html: apidoc dataset-pages
html: apidoc

# Fast build: do NOT execute examples (sphinx-gallery)
.PHONY: html-noplot
html-noplot: apidoc dataset-pages
html-noplot: apidoc
@python prepare_summary_tables.py ../eegdash/ $(BUILDDIR)
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" \
$(SPHINXOPTS) -D sphinx_gallery_conf.plot_gallery=0 $(O)
Expand All @@ -65,5 +48,4 @@ Makefile: ;

%: Makefile
@python prepare_summary_tables.py ../eegdash/ $(BUILDDIR)
@python generate_dataset_pages.py
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
304 changes: 0 additions & 304 deletions docs/generate_dataset_pages.py

This file was deleted.

Loading
Loading