Merge pull request #183 from jGaboardi/update_docs

Updating spaghetti ReadTheDocs
pysal · Dec 3, 2018 · ba000cd · ba000cd
2 parents 8ea174c + 1f921b4
commit ba000cd
Show file tree

Hide file tree

Showing 12 changed files with 86 additions and 80 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -15,23 +15,23 @@ spaghetti.Network
    :toctree: generated/
 
     spaghetti.network.Network
-    spaghetti.network.Network.extractgraph
     spaghetti.network.Network.extract_components
+    spaghetti.network.Network.extractgraph
     spaghetti.network.Network.contiguityweights
     spaghetti.network.Network.distancebandweights
     spaghetti.network.Network.snapobservations
-    spaghetti.network.Network.compute_distance_to_nodes
+    spaghetti.network.Network.compute_distance_to_vertices
     spaghetti.network.Network.compute_snap_dist
-    spaghetti.network.Network.count_per_edge
+    spaghetti.network.Network.count_per_link
     spaghetti.network.Network.simulate_observations
-    spaghetti.network.Network.enum_links_node
-    spaghetti.network.Network.node_distance_matrix
+    spaghetti.network.Network.enum_links_vertex
+    spaghetti.network.Network.full_distance_matrix
     spaghetti.network.Network.allneighbordistances
     spaghetti.network.Network.nearestneighbordistances
     spaghetti.network.Network.NetworkF
     spaghetti.network.Network.NetworkG
     spaghetti.network.Network.NetworkK
-    spaghetti.network.Network.segment_edges
+    spaghetti.network.Network.split_arcs
     spaghetti.network.Network.savenetwork
     spaghetti.network.Network.loadnetwork
 

diff --git a/doc/generated/spaghetti.network.Network.compute_distance_to_nodes.rst b/doc/generated/spaghetti.network.Network.compute_distance_to_nodes.rst
diff --git a/doc/generated/spaghetti.network.Network.compute_distance_to_vertices.rst b/doc/generated/spaghetti.network.Network.compute_distance_to_vertices.rst
@@ -0,0 +1,6 @@
+spaghetti.network.Network.compute\_distance\_to\_vertices
+=========================================================
+
+.. currentmodule:: spaghetti.network
+
+.. automethod:: Network.compute_distance_to_vertices
diff --git a/...ghetti.network.Network.count_per_edge.rst → ...ghetti.network.Network.count_per_link.rst b/...ghetti.network.Network.count_per_edge.rst → ...ghetti.network.Network.count_per_link.rst
@@ -1,6 +1,6 @@
-spaghetti.network.Network.count\_per\_edge
+spaghetti.network.Network.count\_per\_link
 ==========================================
 
 .. currentmodule:: spaghetti.network
 
-.. automethod:: Network.count_per_edge
+.. automethod:: Network.count_per_link
diff --git a/doc/generated/spaghetti.network.Network.enum_links_node.rst b/doc/generated/spaghetti.network.Network.enum_links_node.rst
diff --git a/doc/generated/spaghetti.network.Network.enum_links_vertex.rst b/doc/generated/spaghetti.network.Network.enum_links_vertex.rst
@@ -0,0 +1,6 @@
+spaghetti.network.Network.enum\_links\_vertex
+=============================================
+
+.. currentmodule:: spaghetti.network
+
+.. automethod:: Network.enum_links_vertex
diff --git a/doc/generated/spaghetti.network.Network.full_distance_matrix.rst b/doc/generated/spaghetti.network.Network.full_distance_matrix.rst
@@ -0,0 +1,6 @@
+spaghetti.network.Network.full\_distance\_matrix
+================================================
+
+.. currentmodule:: spaghetti.network
+
+.. automethod:: Network.full_distance_matrix
diff --git a/doc/generated/spaghetti.network.Network.node_distance_matrix.rst b/doc/generated/spaghetti.network.Network.node_distance_matrix.rst
diff --git a/doc/generated/spaghetti.network.Network.rst b/doc/generated/spaghetti.network.Network.rst
@@ -18,21 +18,21 @@ spaghetti.network.Network
       ~Network.NetworkK
       ~Network.__init__
       ~Network.allneighbordistances
-      ~Network.compute_distance_to_nodes
+      ~Network.compute_distance_to_vertices
       ~Network.compute_snap_dist
       ~Network.contiguityweights
-      ~Network.count_per_edge
+      ~Network.count_per_link
       ~Network.distancebandweights
-      ~Network.enum_links_node
+      ~Network.enum_links_vertex
       ~Network.extract_components
       ~Network.extractgraph
+      ~Network.full_distance_matrix
       ~Network.loadnetwork
       ~Network.nearestneighbordistances
-      ~Network.node_distance_matrix
       ~Network.savenetwork
-      ~Network.segment_edges
       ~Network.simulate_observations
       ~Network.snapobservations
+      ~Network.split_arcs
 
 
 

diff --git a/doc/generated/spaghetti.network.Network.segment_edges.rst b/doc/generated/spaghetti.network.Network.segment_edges.rst
diff --git a/doc/generated/spaghetti.network.Network.split_arcs.rst b/doc/generated/spaghetti.network.Network.split_arcs.rst
@@ -0,0 +1,6 @@
+spaghetti.network.Network.split\_arcs
+=====================================
+
+.. currentmodule:: spaghetti.network
+
+.. automethod:: Network.split_arcs