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 #87

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from
Open

New documentation #87

wants to merge 10 commits into from

Conversation

brash6
Copy link
Collaborator

@brash6 brash6 commented Jun 17, 2024

As the title says, this PR is dedicated to documentation updates.

  • A new architecture is implemented
  • Files in utils folder are removed from doc
  • Dependancies are added to setup.py (pytest, sphinx and sphinx_rtd_theme)

TODO:

  • Getting started / Examples pages have to be written
  • We may want to confirm which Python files have to be shown in the doc

@bthirion
Copy link
Collaborator

Thx @brash6 !
The CI is broken atm.
Is there a way to get the generated doc somewhere or do we have to build locally ?

@brash6
Copy link
Collaborator Author

brash6 commented Jun 20, 2024

@bthirion As just discussed with @judithabk6 and @houssamzenati, The problem with the CI is related to a problem solved in #81. This PR will be merged as soon as some tests on inputs are implemented.
On another hand, the documentation should still build correctly in the CI when opening a PR on the main branch



API
=========
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
=========
===

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (develop@8530e26). Learn more about missing BASE report.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             develop      #87   +/-   ##
==========================================
  Coverage           ?   89.08%           
==========================================
  Files              ?        6           
  Lines              ?      733           
  Branches           ?        0           
==========================================
  Hits               ?      653           
  Misses             ?       80           
  Partials           ?        0           

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

@judithabk6 judithabk6 mentioned this pull request Nov 7, 2024
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.

4 participants