📝 docs path analysis

GiulioRossetti · Jun 9, 2020 · e43d3ff · e43d3ff
1 parent 8e57e11
commit e43d3ff
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 0 deletions.
diff --git a/docs/reference/algorithms/algorithms.rst b/docs/reference/algorithms/algorithms.rst
@@ -0,0 +1,11 @@
+**********
+Algorithms
+**********
+
+Dynetx implements standard temporal network measures
+
+.. toctree::
+   :maxdepth: 2
+
+   paths.rst
+
diff --git a/docs/reference/algorithms/paths.rst b/docs/reference/algorithms/paths.rst
@@ -0,0 +1,30 @@
+
+Paths
+=====
+
+Compute the time respecting paths between nodes in the graph.
+
+These algorithms work with undirected and directed graphs.
+
+Time respecting paths
+---------------------
+
+.. automodule:: dynetx.algorithms.paths
+
+.. autosummary::
+   :toctree: generated_alg/
+
+   time_respecting_paths
+   all_time_respecting_paths
+   annotate_paths
+   path_duration
+   path_length
+
+
+Temporal Directed Acyclic Graph
+-------------------------------
+
+.. autosummary::
+   :toctree: generated_alg/
+
+   temporal_dag
diff --git a/docs/reference/reference.rst b/docs/reference/reference.rst
@@ -14,5 +14,6 @@ In ``DyNetx`` are implemented the following **Dynamic Graph** models:
    :maxdepth: 1
 
    classes/gtypes.rst
+   algorithms/algorithms.rst
    functions.rst
    read_write