Merge pull request #392 from thomasrobiglio/dihypergraph-in-quick-ref

update index.rst to have dihypergraph in quick references
xgi-org · Jun 9, 2023 · d7e59cc · d7e59cc
2 parents 4402c47 + 81efa70
commit d7e59cc
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/docs/source/api/classes/xgi.classes.dihypergraph.DiHypergraph.rst b/docs/source/api/classes/xgi.classes.dihypergraph.DiHypergraph.rst
@@ -3,6 +3,8 @@
 
 .. currentmodule:: xgi.classes.dihypergraph
 
+.. warning::
+    This is an experimental module. It is not yet stable and may change in the future.
 .. autoclass:: DiHypergraph
    :show-inheritance:
    :members:

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -23,6 +23,7 @@
 
    Hypergraph class <api/classes/xgi.classes.hypergraph.Hypergraph.rst>
    Simplicial Complex class <api/classes/xgi.classes.simplicialcomplex.SimplicialComplex.rst>
+   Directed Hypergraph class <api/classes/xgi.classes.dihypergraph.DiHypergraph>
 
 .. toctree::
    :maxdepth: 2