update index.rst to have dihypergraph in quick references

[thomasrobiglio]

I noticed that the DH does not appear in the quick references, I think this might fix it (but I'm not familiar at all with how Sphinx works, etc. so pls check it).

[maximelucas]

I saw it too but not sure we want it there since it's still experimental?

[leotrs]

Good point Max

[thomasrobiglio]

Ah right, I did not think about that

[leotrs]

@thomasrobiglio you were right - you can check the documentation built from this PR (instead of from the main branch) by clicking "docs/readthedocs.orx:xgi" under the "all checks have passed" button here in this PR.

[nwlandry]

I think this is a good idea. While this is still an experimental feature, perhaps you can just add (Experimental feature!) or something like that after the text, so that users can still easily find it if they want to use it.

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (8d29604) 91.02% compared to head (81efa70) 91.02%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #392   +/-   ##
=======================================
  Coverage   91.02%   91.02%           
=======================================
  Files          47       47           
  Lines        3878     3878           
=======================================
  Hits         3530     3530           
  Misses        348      348           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[thomasrobiglio]

Now it will appear like this... but maybe this is not what you had in mind @nwlandry (since also there was already the warning in the class docs). Then of course we can change the text, this one was co-authored by copilot :)

[leotrs]

I like the warning admonition. I would delete the middle sentence and leave the first and last.

[nwlandry]

Looks great! I agree with Leo on deleting the middle sentence and then I think you're good to merge, @thomasrobiglio. Thanks so much!