[MNT] Fix details of the documentation (#856)

* Release 1.4.3 (#855)

* V1.4.2 (#845)

* fixing the release

* pushing to including the .csv

* pre-commit

* v 1.4.2

* Fix `SetRawAnnotations` when no stim channel (#838)

* First try to fix

* Add test

* [pre-commit.ci] auto fixes from pre-commit.com hooks

* Whats new

* enforce desired event ids when creating events from annotations

---------

Signed-off-by: Pierre Guetschel <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Increase compatibility with Python 3.14 (#848)

* Initial plan

* Increase compatibility with Python 3.14

Co-authored-by: bruAristimunha <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: bruAristimunha <[email protected]>

* Fix warnings from scikit-learn 1.8+ and introduce FixedPipeline (#850)

* p

* fixing number

* Fix compatibility with scikit-learn 1.8 (#852)

* fixing more colab issues

* updating the utils

* Enhance documentation and update design elements (#853)

* more design details

* more adjust

* more adjusts

* more updates

* updating the readme

* removing the roadmap

* first round

* more modification and almost done

* including subject info

* remove the video

* more details

* updating to colab

* updating the citation

* updating the __init__

* Macro release (#854)

---------

Signed-off-by: Pierre Guetschel <[email protected]>
Co-authored-by: Bru <[email protected]>
Co-authored-by: Pierre Guetschel <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: bruAristimunha <[email protected]>

* updating the md and yml

* updating the DNS config

* more documentation fix

* checking links automatically

* Update README.md

Signed-off-by: Bru <[email protected]>

* more fix within the links

* fixing the url

---------

Signed-off-by: Pierre Guetschel <[email protected]>
Signed-off-by: Bru <[email protected]>
Signed-off-by: Bru <[email protected]>
Co-authored-by: Bruno Aristimunha <[email protected]>
Co-authored-by: Pierre Guetschel <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <[email protected]>

Author: 5 people

.github/workflows/link-check.yml

@@ -0,0 +1,91 @@
+name: Link Check
+
+on:
+  push:
+    branches: [develop, master]
+    paths:
+      - "**.md"
+      - "docs/**"
+      - ".github/workflows/link-check.yml"
+  pull_request:
+    branches: [develop]
+    paths:
+      - "**.md"
+      - "docs/**"
+      - ".github/workflows/link-check.yml"
+  schedule:
+    - cron: "0 0 * * 1"
+  workflow_dispatch:
+
+jobs:
+  link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Check links in Markdown and RST files
+        uses: lycheeverse/lychee-action@v2
+        with:
+          args: >-
+            --verbose
+            --no-progress
+            --accept 200,204,206,301,302,303,307,308,429
+            --timeout 30
+            --max-retries 3
+            --exclude "^mailto:"
+            --exclude "^https://github\\.com/NeuroTechX/moabb/(issues|pulls|compare)"
+            --exclude "^https://github\\.com/.*/(fork|new)"
+            --exclude "localhost"
+            --exclude "127\\.0\\.0\\.1"
+            --exclude "example\\.com"
+            --exclude "^file://"
+            --exclude "^git\\+"
+            --exclude "arxiv\\.org"
+            --exclude "twitter\\.com"
+            --exclude "x\\.com"
+            --exclude "linkedin\\.com"
+            --exclude "app\\.gitter\\.im"
+            --exclude "gitter\\.im"
+            --exclude "gitlab\\.com"
+            --exclude "dx\\.doi\\.org"
+            "./**/*.md"
+            "./**/*.rst"
+          fail: true
+          output: ./lychee-report.md
+
+      - name: Upload link check report
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: link-check-report
+          path: ./lychee-report.md
+          retention-days: 30
+
+      - name: Create issue on link check failure
+        if: failure() && github.event_name == 'schedule'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require('fs');
+            let report = '';
+            try {
+              report = fs.readFileSync('./lychee-report.md', 'utf8');
+            } catch (e) {
+              report = 'Could not read the link check report.';
+            }
+            const issues = await github.rest.issues.listForRepo({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: 'open',
+              labels: 'broken-links'
+            });
+            if (issues.data.length === 0) {
+              await github.rest.issues.create({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                title: 'Broken links detected in documentation',
+                body: `## Automated Link Check Report\n\nThe weekly link check has detected broken links.\n\n<details>\n<summary>Report</summary>\n\n${report}\n\n</details>`,
+                labels: ['broken-links', 'documentation']
+              });
+            }

CODE_OF_CONDUCT.md

@@ -51,7 +51,7 @@ maintainers.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+available at [https://www.contributor-covenant.org/version/1/4/][version]
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://www.contributor-covenant.org
+[version]: https://www.contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -6,7 +6,7 @@ Contributions are always welcome, no matter how small!
 
 If you think you can help in any of the areas of MOABB (and we bet you can) or in any of
 the many areas that we haven't yet thought of (and here we're _sure_ you can) then please
-check out our [roadmap](https://github.com/NeuroTechX/moabb/blob/master/ROADMAP.md).
+check out our [issues](https://github.com/NeuroTechX/moabb/issues).
 
 Please note that it's very important to us that we maintain a positive and supportive
 environment for everyone who wants to participate. When you join us we ask that you follow
@@ -84,9 +84,7 @@ instruments against the code you produced.
 
 For Code Quality verification, we use:
 
-- [`black`](https://github.com/psf/black) - Python code formatting
-- [`isort`](https://github.com/timothycrosley/isort) - imports sorting and grouping
-- [`flake8`](https://gitlab.com/pycqa/flake8) - code style checking
+- [`ruff`](https://github.com/astral-sh/ruff) - Python linting and formatting
 - [`prettier`](https://github.com/prettier/prettier) - `.yml` and `.md` files formatting
 - and more checkers.
 

README.md

@@ -11,11 +11,11 @@
     of freely available EEG datasets.
   </p>
   <p>
-    <a href="https://neurotechx.github.io/moabb/">Docs</a> •
-    <a href="https://neurotechx.github.io/moabb/install/install.html">Install</a> •
-    <a href="https://neurotechx.github.io/moabb/auto_examples/index.html">Examples</a> •
-    <a href="https://neurotechx.github.io/moabb/paper_results.html">Benchmark</a> •
-    <a href="https://neurotechx.github.io/moabb/dataset_summary.html">Datasets</a>
+    <a href="https://moabb.neurotechx.com/">Docs</a> •
+    <a href="https://moabb.neurotechx.com/docs/install/install.html">Install</a> •
+    <a href="https://moabb.neurotechx.com/docs/auto_examples/index.html">Examples</a> •
+    <a href="https://moabb.neurotechx.com/docs/paper_results.html">Benchmark</a> •
+    <a href="https://moabb.neurotechx.com/docs/dataset_summary.html">Datasets</a>
   </p>
   <p>
     <a href="https://doi.org/10.5281/zenodo.10034223"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.10034223.svg" alt="DOI"></a>
@@ -24,12 +24,14 @@
     <a href="https://pypi.org/project/moabb/"><img src="https://img.shields.io/pypi/v/moabb?label=version&color=orange&style=flat-square" alt="Version"></a>
     <a href="https://pypi.org/project/moabb/"><img src="https://img.shields.io/pypi/pyversions/moabb?style=flat-square" alt="Python versions"></a>
     <a href="https://pepy.tech/project/moabb"><img src="https://pepy.tech/badge/moabb" alt="Downloads"></a>
+    <a href="https://github.com/NeuroTechX/moabb/actions/workflows/link-check.yml"><img src="https://github.com/NeuroTechX/moabb/actions/workflows/link-check.yml/badge.svg" alt="Link Check"></a>
   </p>
 </div>
 
 ## Quickstart
 
-```bash
+
+```shell
 pip install moabb
 ```
 
@@ -57,7 +59,8 @@ results = evaluation.process(pipelines)
 print(results.head())
 ```
 
-For full installation options and troubleshooting, see the docs: https://neurotechx.github.io/moabb/install/install.html
+For full installation options and troubleshooting, see the [documentation](https://moabb.neurotechx.com/docs/install/install.html).
+
 
 ## Disclaimer
 
@@ -103,7 +106,7 @@ state of the art by 5% ...”.
 This project is under the umbrella of [NeuroTechX][link_neurotechx], the international
 community for NeuroTech enthusiasts.
 
-The Mother of all BCI Benchmarks was founded by [Alexander Barachant](http://alexandre.barachant.org/) and [Vinay Jayaram](https://vinay-jayaram.github.io/).
+The Mother of all BCI Benchmarks was founded by [Alexander Barachant](http://alexandre.barachant.org/) and [Vinay Jayaram][link_vinay].
 
 It is currently maintained by:
 
@@ -147,17 +150,25 @@ we're here to help.
 
 If you use MOABB in your experiments, please cite MOABB and the related publications:
 
-- Citation guide: https://neurotechx.github.io/moabb/cite.html
+📚 [Full citation guide](https://moabb.neurotechx.com/docs/cite.html)
 
-<details open>
-<summary>Citation (APA + BibTeX)</summary>
+### Software Citation
 
-<p><strong>APA</strong></p>
-<pre><code>Aristimunha, B., Carrara, I., Guetschel, P., Sedlar, S., Rodrigues, P., Sosulski, J., Narayanan, D., Bjareholt, E., Barthelemy, Q., Schirrmeister, R. T., Kobler, R., Kalunga, E., Darmet, L., Gregoire, C., Abdul Hussain, A., Gatti, R., Goncharenko, V., Andreev, A., Thielen, J., Moreau, T., Roy, Y., Jayaram, V., Barachant, A., &amp; Chevallier, S. (2025).
-Mother of all BCI Benchmarks (MOABB) (Version 1.4.3). Zenodo. https://doi.org/10.5281/zenodo.10034223</code></pre>
+#### APA Format
+
+```text
+Aristimunha, B., Carrara, I., Guetschel, P., Sedlar, S., Rodrigues, P., Sosulski, J.,
+Narayanan, D., Bjareholt, E., Barthelemy, Q., Schirrmeister, R. T., Kobler, R.,
+Kalunga, E., Darmet, L., Gregoire, C., Abdul Hussain, A., Gatti, R., Goncharenko, V.,
+Andreev, A., Thielen, J., Moreau, T., Roy, Y., Jayaram, V., Barachant, A., &
+Chevallier, S. (2025). Mother of all BCI Benchmarks (MOABB) (Version 1.4.3).
+Zenodo. https://doi.org/10.5281/zenodo.10034223
+```
 
-<p><strong>BibTeX</strong></p>
-<pre><code>@software{Aristimunha_Mother_of_all,
+#### BibTeX Format
+
+```bibtex
+@software{Aristimunha_Mother_of_all,
   author       = {Aristimunha, Bruno and
                   Carrara, Igor and
                   Guetschel, Pierre and
@@ -188,34 +199,36 @@ Mother of all BCI Benchmarks (MOABB) (Version 1.4.3). Zenodo. https://doi.org/10
   version      = {1.4.3},
   url          = {https://github.com/NeuroTechX/moabb},
   doi          = {10.5281/zenodo.10034223},
-}</code></pre>
+}
+```
 
-<p>If you want to cite the scientific contributions of MOABB, you could use the following papers:</p>
+### Scientific Publications
 
-<blockquote>
-  <p>
-    Sylvain Chevallier, Igor Carrara, Bruno Aristimunha, Pierre Guetschel, Sara Sedlar, Bruna Junqueira Lopes,
-    Sébastien Velut, Salim Khazem, Thomas Moreau<br>
-    <a href="https://cnrs.hal.science/hal-04537061/">“The largest EEG-based BCI reproducibility study for open science: the MOABB benchmark”</a><br>
-    HAL: hal-04537061.
-  </p>
-</blockquote>
+If you want to cite the scientific contributions of MOABB, please use the following papers:
 
-<blockquote>
-  <p>
-    Vinay Jayaram and Alexandre Barachant.<br>
-    <a href="http://iopscience.iop.org/article/10.1088/1741-2552/aadea0/meta">“MOABB: trustworthy algorithm benchmarking for BCIs.”</a><br>
-    Journal of neural engineering 15.6 (2018): 066011.<br>
-    <a href="https://doi.org/10.1088/1741-2552/aadea0">DOI</a>
-  </p>
-</blockquote>
+#### MOABB Benchmark Paper
+
+> Sylvain Chevallier, Igor Carrara, Bruno Aristimunha, Pierre Guetschel, Sara Sedlar,
+> Bruna Junqueira Lopes, Sébastien Velut, Salim Khazem, Thomas Moreau
+>
+> **["The largest EEG-based BCI reproducibility study for open science: the MOABB benchmark"](https://cnrs.hal.science/hal-04537061/)**
+>
+> HAL: hal-04537061
+
+#### Original MOABB Paper
+
+> Vinay Jayaram and Alexandre Barachant
+>
+> **["MOABB: trustworthy algorithm benchmarking for BCIs"](https://doi.org/10.1088/1741-2552/aadea0)**
+>
+> Journal of Neural Engineering 15.6 (2018): 066011
+>
+> [DOI: 10.1088/1741-2552/aadea0](https://doi.org/10.1088/1741-2552/aadea0)
 
-<p>
-  If you publish a paper using MOABB, please contact us on Github and open an issue!
-  We would love to hear about your work and help you promote it.
-</p>
+---
 
-</details>
+📣 **If you publish a paper using MOABB, please [open an issue](https://github.com/NeuroTechX/moabb/issues) to let us know!**
+We would love to hear about your work and help you promote it.
 
 ## Contact us
 
@@ -233,6 +246,6 @@ because then we can get right on it.
 [link_pierre]: https://www.linkedin.com/in/pierreguetschel/
 [link_neurotechx_signup]: https://neurotechx.com/
 [link_gitter]: https://app.gitter.im/#/room/#moabb_dev_community:gitter.im
-[link_moabb_docs]: https://neurotechx.github.io/moabb/
+[link_moabb_docs]: https://moabb.neurotechx.com/
 [link_arxiv]: https://arxiv.org/abs/1805.06427
-[link_jne]: http://iopscience.iop.org/article/10.1088/1741-2552/aadea0/meta
+[link_jne]: https://doi.org/10.1088/1741-2552/aadea0

docs/source/_templates/custom-template.html

@@ -1 +1 @@
-If you use MOABB, remember to <a href="https://neurotechx.github.io/moabb/cite.html">cite</a>! The largest BCI EEG benchmark is out! Check the <a href="https://neurotechx.github.io/moabb/paper_results.html">results</a>.
+If you use MOABB, remember to <a href="https://moabb.neurotechx.com/docs/cite.html">cite</a>! The largest BCI EEG benchmark is out! Check the <a href="https://moabb.neurotechx.com/docs/paper_results.html">results</a>.

docs/source/_templates/layout.html

@@ -1,7 +1,7 @@
 {%- extends 'pydata_sphinx_theme/layout.html' %}
 
 {% block extrahead %}
-    <link rel="canonical" href="https://neurotechx.github.io/moabb/{{ pagename }}.html" />
+    <link rel="canonical" href="https://moabb.neurotechx.com/docs/{{ pagename }}.html" />
     {{ super() }}
 {% endblock %}
 

docs/source/conf.py

@@ -289,7 +289,7 @@ def linkcode_resolve(domain, info):  # noqa: C901
 html_static_path = ["_static"]
 
 # Base URL for sitemap generation (required by sphinx_sitemap)
-html_baseurl = "https://neurotechx.github.io/moabb/"
+html_baseurl = "https://moabb.neurotechx.com/docs/"
 
 # Sitemap configuration
 sitemap_url_scheme = "{link}"

docs/source/dataset_summary.rst

@@ -17,9 +17,9 @@ there is a tutorial explaining how to do so, and we welcome warmly any new contr
 
 It is possible to use an external dataset within MOABB as long as it is in Brain Imaging Data Structure (BIDS) format.
 See this `guide <https://bids-specification.readthedocs.io/en/stable/#:~:text=The%20Brain%20Imaging%20Data%20Structure%20(BIDS)%20is%20a%20simple%20and,to%20help%20implement%20the%20standard.>`__ for more information on how to structure your data according to BIDS
-You can use this `class <https://moabb.neurotechx.com/docs/api/generated/moabb.datasets.base.LocalBIDSDataset.html#moabb.datasets.base.LocalBIDSDataset>`__ to convert your local dataset to work within MOABB without creating a new dataset class.
+You can use this `class <https://moabb.neurotechx.com/docs/generated/moabb.datasets.base.LocalBIDSDataset.html>`__ to convert your local dataset to work within MOABB without creating a new dataset class.
 
-See also `Datasets-Support <https://github.com/NeuroTechX/moabb/wiki/Datasets-Support>`__ for supplementary
+See also the `Wiki <https://github.com/NeuroTechX/moabb/wiki>`__ for supplementary
 detail on datasets (class name, size, licence, etc.)
 Dataset, #Subj, #Chan, #Classes, #Trials, Trial length, Freq, #Session, #Runs, Total_trials, PapersWithCode leaderboard
 
@@ -163,7 +163,7 @@ currently on our radar can be seen `here <https://github.com/NeuroTechX/moabb/is
 but we are open to any suggestion.
 
 If you want to actively contribute to inclusion of one new dataset, you can follow also this tutorial
-`tutorial <https://neurotechx.github.io/moabb/auto_tutorials/tutorial_4_adding_a_dataset.html>`__.
+`tutorial <https://moabb.neurotechx.com/docs/auto_examples/tutorials/tutorial_4_adding_a_dataset.html>`__.
 
 .. raw:: html
 

docs/source/install/install_source.rst

@@ -4,7 +4,7 @@ Installation from Sources
 ===========================
 
 This guide is intended for users who want to test experimental features or contribute to MOABB’s development. If you only need the stable release, please refer to our
-`pip installation guide <https://neurotechx.github.io/moabb/install/install_pip.html#install-pip>`__.
+`pip installation guide <https://moabb.neurotechx.com/docs/install/install_pip.html#install-pip>`__.
 
 .. note::
    For a straightforward MOABB installation (without development), please see the pip installation guide.

docs/source/paper_results.rst

@@ -48,7 +48,7 @@ We report the results of the benchmark study performed in:
    Visualization of the MOABB datasets, with Motor Imagery (MI) in green, ERP in pink/purple and SSVEP in orange/brown. The size of the circle is proportional to the number of subjects and the contrast depends on the number of electrodes.
 
 This study conducts an extensive Brain-computer interfaces (BCI) reproducibility analysis on open electroencephalography datasets,
-aiming to assess existing solutions and establish open and reproducible benchmarks for effective comparison within the field. Please note that the results are obtained using `Within-Session evaluation <http://moabb.neurotechx.com/docs/api/generated/moabb.evaluations.WithinSessionEvaluation.html>`_.
+aiming to assess existing solutions and establish open and reproducible benchmarks for effective comparison within the field. Please note that the results are obtained using `Within-Session evaluation <https://moabb.neurotechx.com/docs/generated/moabb.evaluations.WithinSessionEvaluation.html>`_.
 The results are reported regarding mean accuracy and standard deviation across all folds for all sessions and subjects.
 
 If you use the same evaluation procedure, you should expect similar results if you use the same pipelines and datasets, with some minor variations due to the randomness of the cross-validation procedure.