Skip to content

Commit 8732443

Browse files
Merge pull request #150 from sccn/develop
[DOCS] updating the webpage and removing the xarray
2 parents 54d4f41 + 5bde952 commit 8732443

35 files changed

+2983
-810
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ build/
2020

2121
dist/
2222
docs/build/
23-
docs/source/sg_execution_times.rst
2423
docs/source/gen_modules/
2524
docs/source/generated/
2625
docs/auto_examples/
@@ -44,3 +43,7 @@ data/
4443
*.json
4544
*.isorted
4645
*.py.isorted
46+
47+
examples/eeg2025/weights*
48+
# Generated dataset visualizations
49+
docs/source/_static/dataset_generated/

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ repos:
2222
- --select=E,W,F,D,NPY201
2323
- --ignore=E402,E501,D100,D101,D102,D103,D104,D105,D107,D205,D400,D415,D417,F403,D401,E741,E722,D419
2424
files: ^(eegdash|docs|notebooks|scripts|tests)/
25-
exclude: \.ipynb$
25+
exclude: (\.ipynb$|docs/prepare_summary_tables\.py$)
2626
- id: ruff
2727
name: ruff examples
2828
args:

api_dataset.rst

Lines changed: 591 additions & 0 deletions
Large diffs are not rendered by default.

docs/Makefile

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,34 +12,17 @@ help:
1212
.PHONY: apidoc
1313
apidoc:
1414
# Generate full API docs, then prune duplicates covered by autosummary
15-
@python -m sphinx.ext.apidoc -f -e -M -o "$(APIDIR)/dataset" "../$(PKG)"
15+
@SPHINX_APIDOC_OPTIONS=members,undoc-members,show-inheritance,noindex \
16+
python -m sphinx.ext.apidoc -f -e -M -o "$(APIDIR)/dataset" "../$(PKG)"
1617
# Remove top-level package page and modules covered elsewhere
17-
@rm -f "$(APIDIR)/dataset/eegdash.rst"
18-
@rm -f "$(APIDIR)/dataset/eegdash.api.rst"
19-
@rm -f "$(APIDIR)/dataset/eegdash.bids_eeg_metadata.rst"
20-
@rm -f "$(APIDIR)/dataset/eegdash.const.rst"
21-
@rm -f "$(APIDIR)/dataset/eegdash.data_utils.rst"
22-
@rm -f "$(APIDIR)/dataset/eegdash.logging.rst"
23-
@rm -f "$(APIDIR)/dataset/eegdash.mongodb.rst"
24-
@rm -f "$(APIDIR)/dataset/eegdash.paths.rst"
25-
@rm -f "$(APIDIR)/dataset/eegdash.utils.rst"
26-
@rm -f "$(APIDIR)/dataset/eegdash.features.rst"
27-
@rm -f $(APIDIR)/dataset/eegdash.features.*.rst
28-
@rm -f "$(APIDIR)/dataset/eegdash.hbn.rst"
29-
@rm -f $(APIDIR)/dataset/eegdash.hbn.*.rst
30-
@rm -f "$(APIDIR)/dataset/modules.rst"
3118

32-
.PHONY: dataset-pages
33-
dataset-pages:
34-
# Generate individual dataset documentation pages
35-
@python generate_dataset_pages.py
3619

3720
# Standard build runs examples
38-
html: apidoc dataset-pages
21+
html: apidoc
3922

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

6649
%: Makefile
6750
@python prepare_summary_tables.py ../eegdash/ $(BUILDDIR)
68-
@python generate_dataset_pages.py
6951
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/generate_dataset_pages.py

Lines changed: 0 additions & 304 deletions
This file was deleted.

0 commit comments

Comments
 (0)