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

Missing focus tutorials in API #475

Closed
wants to merge 45 commits into from

Conversation

thomasrobiglio
Copy link
Collaborator

No description provided.

This reverts commit 295c4bf.
This reverts commit a3b7ba4.
This reverts commit ec09cce.
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Oct 16, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (1b8df54) 91.90% compared to head (e444907) 91.90%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #475   +/-   ##
=======================================
  Coverage   91.90%   91.90%           
=======================================
  Files          60       60           
  Lines        4375     4375           
=======================================
  Hits         4021     4021           
  Misses        354      354           

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

@nwlandry
Copy link
Collaborator

Thanks @thomasrobiglio! Looks great! Two quick question before you merge: (1) can we remove the top-level tutorials folder now? (2) can we get rid of the quickstart notebook? Thanks for all the work on this!

@nwlandry
Copy link
Collaborator

Oops! I was looking at the wrong branch! Disregard (1).

@thomasrobiglio
Copy link
Collaborator Author

Yes, we can remove the quickstart tuto. If we don't have time constraints for a new release I'd like to take 2-3 more days to check for imprecisions before merging.

@nwlandry
Copy link
Collaborator

Sounds great! I'll approve it and you can merge it when you think it's ready.

@maximelucas
Copy link
Collaborator

Nice! I added another In Depth tuto in #456 but somehow I cannot see in main now.
Could you add it?
https://github.com/xgi-org/xgi/blob/4e513734dfa4a22bc3095fe524398b8ae7a8d6cd/docs/source/api/tutorials/In%20Depth%202%20-%20Drawing%20hyperedges.ipynb

@thomasrobiglio
Copy link
Collaborator Author

thomasrobiglio commented Oct 17, 2023

@maximelucas will do tomorrow. To see it in the API you should also put the reference in the corresponding .rst file (https://github.com/xgi-org/xgi/blob/main/docs/source/api/tutorials/in_depth.rst#in-depth-tutorials in this case).

Idk if there is an automated way to have all the .ipynb files displayed but the way we are doing it now has some upsides e.g. we can choose the order in which tutos are displayed and create the different categories.

@thomasrobiglio
Copy link
Collaborator Author

I will open a new PR, I messed up something locally.

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.

3 participants