attempt at listing the available statistics

docs/source/api/stats.rst

@@ -4,40 +4,110 @@ stats package
 
 .. automodule:: xgi.stats
 
-.. rubric:: Modules
+.. admonition:: Available statistics
+
+   .. rubric:: Hypergraphs and simplicial complexes
 
-.. autosummary::
-   :toctree: stats
+   *Statistics of nodes*
 
-   ~xgi.stats.nodestats
-   ~xgi.stats.edgestats
-   ~xgi.stats.dinodestats
-   ~xgi.stats.diedgestats
+   .. autosummary::
+      :nosignatures:
+
+      ~xgi.stats.nodestats.average_neighbor_degree
+      ~xgi.stats.nodestats.clique_eigenvector_centrality
+      ~xgi.stats.nodestats.clustering_coefficient
+      ~xgi.stats.nodestats.degree
+      ~xgi.stats.nodestats.eigenvector_centrality
+      ~xgi.stats.nodestats.local_clustering_coefficient
+      ~xgi.stats.nodestats.node_edge_centrality
+      ~xgi.stats.nodestats.two_nodes_clustering_coefficient
 
+   *Statistics of edges*
 
-.. rubric:: Classes
+   .. autosummary::
+      :nosignatures:
 
-.. autosummary::
-   :toctree: stats
-   :nosignatures:
+      ~xgi.stats.edgestats.order
+      ~xgi.stats.edgestats.size
+      ~xgi.stats.edgestats.node_edge_centrality
 
-   ~xgi.stats.NodeStat
-   ~xgi.stats.EdgeStat
-   ~xgi.stats.DiNodeStat
-   ~xgi.stats.DiEdgeStat
-   ~xgi.stats.MultiNodeStat
-   ~xgi.stats.MultiEdgeStat
-   ~xgi.stats.MultiDiNodeStat
-   ~xgi.stats.MultiDiEdgeStat
+   *Corresponding decorators*
 
+   .. autosummary::
+      :toctree: stats
+      :nosignatures:
 
-.. rubric:: Decorators
+      ~xgi.stats.nodestat_func
+      ~xgi.stats.edgestat_func
 
-.. autosummary::
-   :toctree: stats
-   :nosignatures:
+   *Corresponding modules*
 
-   ~xgi.stats.nodestat_func
-   ~xgi.stats.edgestat_func
-   ~xgi.stats.dinodestat_func
-   ~xgi.stats.diedgestat_func
+   .. autosummary::
+      :toctree: stats
+
+      ~xgi.stats.nodestats
+      ~xgi.stats.edgestats
+
+   *Corresponding classes*
+
+   .. autosummary::
+      :toctree: stats
+      :nosignatures:
+
+      ~xgi.stats.NodeStat
+      ~xgi.stats.EdgeStat
+      ~xgi.stats.MultiNodeStat
+      ~xgi.stats.MultiEdgeStat
+
+   .. rubric:: Directed hypergraphs
+
+
+   *Statistics of nodes*
+
+   .. autosummary::
+      :nosignatures:
+
+      ~xgi.stats.dinodestats.degree
+      ~xgi.stats.dinodestats.in_degree
+      ~xgi.stats.dinodestats.out_degree
+
+   *Statistics of edges*
+
+   .. autosummary::
+      :nosignatures:
+
+      ~xgi.stats.diedgestats.order
+      ~xgi.stats.diedgestats.size
+      ~xgi.stats.diedgestats.head_order
+      ~xgi.stats.diedgestats.head_size
+      ~xgi.stats.diedgestats.tail_order
+      ~xgi.stats.diedgestats.tail_size
+
+   *Corresponding decorators*
+
+   .. autosummary::
+      :toctree: stats
+      :nosignatures:
+
+      ~xgi.stats.dinodestat_func
+      ~xgi.stats.diedgestat_func
+
+   *Corresponding modules*
+
+   .. autosummary::
+      :toctree: stats
+
+      ~xgi.stats.dinodestats
+      ~xgi.stats.diedgestats
+
+
+   *Corresponding classes*
+
+   .. autosummary::
+      :toctree: stats
+      :nosignatures:
+
+      ~xgi.stats.DiNodeStat
+      ~xgi.stats.DiEdgeStat
+      ~xgi.stats.MultiDiNodeStat
+      ~xgi.stats.MultiDiEdgeStat