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

Create ReadTheDoc documentation #35

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

Create ReadTheDoc documentation #35

wants to merge 6 commits into from

Conversation

Galileo-Galilei
Copy link
Collaborator

This PR intends to :

  • add * a lot* of documentation, divide it in section and make it easier to grasp for beginners
  • add the ReadTheDocs setup to publish this documentation to new users and make it more discoverable, especially when cherching on Google
  • I also plan to simplify the Readme a lot, but maybe this will be for another PR

@Galileo-Galilei Galileo-Galilei marked this pull request as draft November 8, 2024 21:53
@codecov-commenter
Copy link

codecov-commenter commented Nov 8, 2024

⚠️ 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 ✅

Project coverage is 59.65%. Comparing base (b9cd2d0) to head (ea3ff33).

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #35   +/-   ##
=======================================
  Coverage   59.65%   59.65%           
=======================================
  Files          26       26           
  Lines         865      865           
=======================================
  Hits          516      516           
  Misses        349      349           

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

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