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 documentation #128

Draft
wants to merge 6 commits into
base: dev
Choose a base branch
from
Draft

📚 New documentation #128

wants to merge 6 commits into from

Conversation

fira7s
Copy link

@fira7s fira7s commented Jan 6, 2025

  • New documentation
  • Fix tutorials page
  • Fix dependencies
  • Fix docstring placement

Copy link

codecov bot commented Jan 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.15%. Comparing base (5f6c625) to head (12cbd1f).
Report is 1 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #128   +/-   ##
=======================================
  Coverage   99.15%   99.15%           
=======================================
  Files         143      143           
  Lines        7136     7138    +2     
  Branches      910      910           
=======================================
+ Hits         7076     7078    +2     
  Misses         27       27           
  Partials       33       33           
Flag Coverage Δ
cpu 99.15% <100.00%> (+<0.01%) ⬆️
pytest 99.15% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@o-laurent
Copy link
Contributor

Hey,

Thank you for the PR. I'll let you handle it, but are you sure that you want to move all class docstrings to the root instead of the __init__? Is it necessary because of the new template?

@o-laurent o-laurent added the documentation Improvements or additions to documentation label Jan 6, 2025
@fira7s
Copy link
Author

fira7s commented Jan 6, 2025

Hey, i will look more into it and leave relevant doctoring under the__init__

@o-laurent o-laurent requested review from o-laurent and alafage and removed request for o-laurent January 6, 2025 17:11
@o-laurent o-laurent changed the title 📚 New docs 📚 New documentation Jan 6, 2025
Copy link
Contributor

@o-laurent o-laurent 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 your work!

Copy link
Contributor

Choose a reason for hiding this comment

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

do we really need to put caps in the paths?

Copy link
Contributor

@alafage alafage Jan 6, 2025

Choose a reason for hiding this comment

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

I don't think we do, it might be better to have them in lowercase

Copy link
Contributor

@o-laurent o-laurent Jan 6, 2025

Choose a reason for hiding this comment

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

Can we find a solution to avoid script duplication? Maybe through symbolic links, for instance? This may result in a very long GitHub action time, though; we should maybe try something at a lower level to reuse the same pages.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe use a more expressive name?


import tu_sphinx_theme
Copy link
Contributor

Choose a reason for hiding this comment

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

remove tu_sphink_theme from the deps

Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't have been pushed in my opinion, since we want to keep all the corruptions in the end

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants