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

Attempt at integrating the tutorials in API #457

Merged
merged 42 commits into from
Oct 16, 2023

Conversation

thomasrobiglio
Copy link
Collaborator

No description provided.

@codecov
Copy link

codecov bot commented Aug 25, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (2962f82) 91.86% compared to head (5628709) 91.90%.
Report is 12 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #457      +/-   ##
==========================================
+ Coverage   91.86%   91.90%   +0.04%     
==========================================
  Files          60       60              
  Lines        4300     4375      +75     
==========================================
+ Hits         3950     4021      +71     
- Misses        350      354       +4     

see 6 files with indirect coverage changes

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

@nwlandry nwlandry mentioned this pull request Sep 11, 2023
31 tasks
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@maximelucas
Copy link
Collaborator

Nice work, thanks so much @thomasrobiglio !! Honestly I think it looks good.
We could start being picky with some of the spacing but I'd say let's do that only later when we change to the other documentation theme.

Minor things:

  • the links to other tutorials link to the github notebooks, instead of the documentation tutorial.
  • The names of the tutorials don't look consistent. That's coming from the titles inside the notebooks I think?
Screenshot 2023-09-29 at 17 46 01

Finally I was just wondering how much of this is automatised/customisable? What's the workflow when we add new tutorials?

@maximelucas maximelucas marked this pull request as ready for review September 29, 2023 16:10
@thomasrobiglio thomasrobiglio changed the title Attempt at integrating the docs in API Attempt at integrating the tutorials in API Oct 9, 2023
@thomasrobiglio
Copy link
Collaborator Author

thomasrobiglio commented Oct 10, 2023

TO DO:

  • uniform titles 🆗
  • fix links 🆗
  • put different categories ("Getting started", "Focus tutorials" etc.) in different files and change appearance of toctrees
  • add missing descriptions in recipes 🆗

Closing #463 #464 #451 as incorporated in this PR.

@thomasrobiglio
Copy link
Collaborator Author

I am updating the links, since I am 'guessing' them I might need to open another pr once the version of the readthedocs with the tutos is stable

@thomasrobiglio
Copy link
Collaborator Author

Ok, everything we discussed last week is done. I have also added a recipe for the multilayer draw (it is not shown anywhere else otherwise).

This is now ready for reviewing and merging.

Screenshot 2023-10-16 alle 14 40 04

@nwlandry
Copy link
Collaborator

Looks good @thomasrobiglio and ready to merge if @maximelucas agrees. The only small detail is to change the "-" to "." in the title of Recipe 12.

@maximelucas
Copy link
Collaborator

Looks great, thanks so much Thomas!!! This is a big step for our docs.

@thomasrobiglio thomasrobiglio merged commit 1b8df54 into xgi-org:main Oct 16, 2023
18 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.

Add tutorials and cookbook to the readthedocs. Cookbook - list suggestion
3 participants