Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation #78

Closed
2 tasks
sylvchev opened this issue Jan 17, 2020 · 3 comments · Fixed by #174
Closed
2 tasks

Update Documentation #78

sylvchev opened this issue Jan 17, 2020 · 3 comments · Fixed by #174

Comments

@sylvchev
Copy link
Member

Documentation needs care. Apart from issue #46, I spotted some minor corrections to make:

  • In API, SSVEPExo() appears in MI datasets which is not correct. It is also correctly listed in SSVEP datasets
  • Paradigms in API list only Motor Imagery, no ERP nor SSVEP.
@Div12345
Copy link
Collaborator

Div12345 commented Mar 12, 2021

I think the automatic update of the Sphinx Documentation is probably not working. Will look into maybe using something like this https://github.com/marketplace/actions/sphinx-build for ensuring that.

An example for using it - https://github.com/ammaraskar/sphinx-action-test

@Div12345
Copy link
Collaborator

Or an alternate would be using something like https://docs.readthedocs.io/en/stable/features.html

@sylvchev
Copy link
Member Author

The documentation may be hosted on https://github.com/NeuroTechX/moabb.github.io repo. There is a CircleCI config item to automatically build the documentation and push it to the moabb.github.io page. It seems not to be working right now.
We may remove the CircleCI config file as it is not used right now, but it is still visible in the history. Like here: https://github.com/NeuroTechX/moabb/blob/55f77ae305e1f0960e781a57895cb34ad6af0c62/.circleci/config.yml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
MOABB
  
Completed
Development

Successfully merging a pull request may close this issue.

2 participants