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
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
cc76ccd
first attempt
thomasrobiglio Aug 25, 2023
0ae00cf
add nbsphinx in the requirements
thomasrobiglio Aug 25, 2023
c9a4eaa
attempt: movimg tutorials in docs/api
thomasrobiglio Aug 25, 2023
7cc6469
adding 5 and 15 minutes
thomasrobiglio Aug 25, 2023
093337b
update test.yml with new location of the tutorials
thomasrobiglio Aug 25, 2023
2029a50
fix: wrong path in previous commit
thomasrobiglio Aug 25, 2023
295c4bf
minor fix
thomasrobiglio Aug 25, 2023
49b2c7c
Attempt: Tutorials in outside docs folder with nbsphinx-link
thomasrobiglio Aug 25, 2023
ec09cce
minor fix
thomasrobiglio Aug 25, 2023
3f4e9e2
attempt: fix wrong path in previous commit
thomasrobiglio Aug 25, 2023
f4a416b
attempt at fix: tutorial not showing in the api
thomasrobiglio Aug 25, 2023
84c6b11
attempt: maybe the issue is the spaces
thomasrobiglio Aug 25, 2023
a3b7ba4
Revert "minor fix"
thomasrobiglio Sep 12, 2023
ac66eba
Revert "Revert "minor fix""
thomasrobiglio Sep 12, 2023
5a72e8b
Revert "attempt: maybe the issue is the spaces"
thomasrobiglio Sep 12, 2023
cbf5c3f
Revert "attempt at fix: tutorial not showing in the api"
thomasrobiglio Sep 12, 2023
d0af6be
Revert "attempt: fix wrong path in previous commit"
thomasrobiglio Sep 12, 2023
0fa4ae5
Revert "minor fix"
thomasrobiglio Sep 12, 2023
1c90401
Revert "Attempt: Tutorials in outside docs folder with nbsphinx-link"
thomasrobiglio Sep 12, 2023
6774290
adding more tutorials in the API
thomasrobiglio Sep 12, 2023
87a834a
feat: included recipes from #451 #463 #464
thomasrobiglio Sep 12, 2023
186c0b4
add recipes in API
thomasrobiglio Sep 12, 2023
fbc5a68
attempt at fixing
thomasrobiglio Sep 12, 2023
be6c16d
attempt at fix
thomasrobiglio Sep 12, 2023
e3411f2
Adding title to recipes.rst
thomasrobiglio Sep 12, 2023
9761584
Tutorials and recipes in same toctree
thomasrobiglio Sep 15, 2023
8ed8292
style: uniform titles for tutos
thomasrobiglio Oct 10, 2023
339de1e
minor changes
thomasrobiglio Oct 10, 2023
3957ae2
attempt at changing the depth of toctrees
thomasrobiglio Oct 10, 2023
1cf8659
minor fix : markdown hierarchy in plotting tuto
thomasrobiglio Oct 10, 2023
0c22432
minor changes
thomasrobiglio Oct 16, 2023
c781399
links: XGI in 15 mins
thomasrobiglio Oct 16, 2023
8066fa2
links: XGI in 5 mins
thomasrobiglio Oct 16, 2023
8b4406f
links: XGI in 1 min
thomasrobiglio Oct 16, 2023
762db72
added missing descriptions in recipes
thomasrobiglio Oct 16, 2023
58e0de8
change toctree structure in tutorials.rst
thomasrobiglio Oct 16, 2023
ca647d4
second attempt toc structure
thomasrobiglio Oct 16, 2023
9e5a13a
attempt for nested toc structure
thomasrobiglio Oct 16, 2023
7edb1bc
minor fix
thomasrobiglio Oct 16, 2023
377752f
add recipe for multilayer draw
thomasrobiglio Oct 16, 2023
a1880a2
minor fix
thomasrobiglio Oct 16, 2023
5628709
- to .
thomasrobiglio Oct 16, 2023
f96558e
add focus_tutorials.rst
thomasrobiglio Oct 16, 2023
7d2fff7
minor fix
thomasrobiglio Oct 16, 2023
e444907
Merge branch 'main' into tutorials_in_api
thomasrobiglio Oct 16, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/api/tutorials/case_studies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Case studies
##################

.. toctree::
:maxdepth: 2
:maxdepth: 1

case_study_zhang2022
simplicial_kuramoto_example
16 changes: 16 additions & 0 deletions docs/source/api/tutorials/focus_tutorials.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
##################
Focus tutorials
##################


.. toctree::
:maxdepth: 1

Tutorial 1 - Basic Hypergraph Functionality
Tutorial 2 - Read and Write
Tutorial 3 - Basic simplicial complex usage
Tutorial 4 - Generative_Models
Tutorial 5 - Plotting
Tutorial 6 - Statistics
Tutorial 7 - Convex hulls hypergraph plotting
Tutorial 8 - Directed Hypergraphs
Loading