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

New theme, PyData #353

Merged
merged 58 commits into from Apr 4, 2023
Merged

New theme, PyData #353

merged 58 commits into from Apr 4, 2023

Conversation

bruAristimunha
Copy link
Collaborator

@bruAristimunha bruAristimunha commented Mar 30, 2023

Related with #352.

I still need to improve another part of doc. Improve user journey, color system, add text on new modules (braindecode, tensorflow, codecarbon).

Maybe better organize the flow and differentiate between gallery and tutorial.

Refactoring the readme

CONTRIBUTING.md Outdated Show resolved Hide resolved
@bruAristimunha
Copy link
Collaborator Author

The new documentation is alive! Please review. I wrote a looot of new things... so we need to validate the small steps.

Since this PR focuses on documentation migration, I wish we didn't focus so much on designing things that can be improved later to speed up the release.

In summary, I reorganized the readme, installed several new dependencies for documentation, and completely refactored the config.py that generates the documentation.

I made some space adjustments, created some pictures for moabb, re-made the logo with a vectorized option, turned the tables into something dynamic, created a new section for installation, and wrote the installation tutorials and an overview section.

Much of the text is based on braindecode, mne, pandas and monai.

Copy link
Member

@sylvchev sylvchev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant! The new doc is so nice, really much more clear and organized.

CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/source/install/install_source.rst Outdated Show resolved Hide resolved
docs/source/install/install_source.rst Outdated Show resolved Hide resolved
bruAristimunha and others added 8 commits April 4, 2023 15:47
Co-authored-by: Sylvain Chevallier <sylvain.chevallier@universite-paris-saclay.fr>
Co-authored-by: Sylvain Chevallier <sylvain.chevallier@universite-paris-saclay.fr>
Co-authored-by: Sylvain Chevallier <sylvain.chevallier@universite-paris-saclay.fr>
@bruAristimunha
Copy link
Collaborator Author

I updated the doc, it's done, for me, it's fine for the merge

@sylvchev
Copy link
Member

sylvchev commented Apr 4, 2023

Eternal thanks @bruAristimunha 🔥

@sylvchev sylvchev merged commit 4d8f110 into NeuroTechX:develop Apr 4, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants