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

Improve doc rendering #310

Merged
merged 8 commits into from
Sep 13, 2024
Merged

Improve doc rendering #310

merged 8 commits into from
Sep 13, 2024

Conversation

qbarthelemy
Copy link
Member

@qbarthelemy qbarthelemy commented Sep 13, 2024

This PR aims to:

  • plot a mini-gallery of examples at the bottom of each class,
  • remove warnings and errors during doc build,
  • remove a useless download to speed up doc build.

Also, sort imports in examples and in lib.

Copy link
Collaborator

@gcattan gcattan left a comment

Choose a reason for hiding this comment

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

Thanks for all the changes @qbarthelemy !

I am checking the new doc build, but I don't see the little mini-gallery yet.

image

doc/conf.py Outdated
'gallery_dirs': ['auto_examples']
'examples_dirs': ['../examples'],
'gallery_dirs': ['auto_examples'],
'doc_module': 'pyriemann-qiskit',
Copy link
Collaborator

Choose a reason for hiding this comment

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

I am not sure here. Should it be pyriemann-qiskit or pyriemann_qiskit?

Copy link
Member Author

Choose a reason for hiding this comment

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

Well spotted!

@gcattan gcattan merged commit 461e546 into pyRiemann:main Sep 13, 2024
13 checks passed
@qbarthelemy qbarthelemy deleted the doc branch September 14, 2024 11:58
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.

2 participants