Skip to content

Commit

Permalink
Merge pull request #166 from jGaboardi/restructure_docs
Browse files Browse the repository at this point in the history
Restructure docs
  • Loading branch information
jGaboardi committed Nov 26, 2018
2 parents 1d6b9a7 + f595172 commit 0e07494
Show file tree
Hide file tree
Showing 43 changed files with 162 additions and 156 deletions.
68 changes: 37 additions & 31 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,55 +8,61 @@ API reference
.. _network_api:


spaghetti
---------

.. autosummary::
:toctree: generated/

element_as_gdf


spaghetti.Network
-----------------

.. autosummary::
:toctree: generated/

Network
Network.extractgraph
Network.contiguityweights
Network.distancebandweights
Network.snapobservations
Network.compute_distance_to_nodes
Network.compute_snap_dist
Network.count_per_edge
Network.simulate_observations
Network.enum_links_node
Network.node_distance_matrix
Network.allneighbordistances
Network.nearestneighbordistances
Network.NetworkF
Network.NetworkG
Network.NetworkK
Network.segment_edges
Network.savenetwork
Network.loadnetwork
spaghetti.network.Network
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_snap_dist
spaghetti.network.Network.count_per_edge
spaghetti.network.Network.simulate_observations
spaghetti.network.Network.enum_links_node
spaghetti.network.Network.node_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.savenetwork
spaghetti.network.Network.loadnetwork


.. _network_api:

spaghetti.PointPattern
----------------------

.. autosummary::
:toctree: generated/

PointPattern

spaghetti.network.PointPattern


.. _network_api:

spaghetti.SimulatedPointPattern
-------------------------------

.. autosummary::
:toctree: generated/

SimulatedPointPattern
spaghetti.network.SimulatedPointPattern


.. _network_api:

spaghetti
---------

.. autosummary::
:toctree: generated/

spaghetti.network.element_as_gdf
6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.NetworkF.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.NetworkG.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.NetworkK.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.allneighbordistances.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.compute_distance_to_nodes.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.compute_snap_dist.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.contiguityweights.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.count_per_edge.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.distancebandweights.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.enum_links_node.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.extractgraph.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.loadnetwork.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.nearestneighbordistances.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.node_distance_matrix.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.savenetwork.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.segment_edges.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.simulate_observations.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.Network.snapobservations.rst

This file was deleted.

6 changes: 0 additions & 6 deletions doc/generated/spaghetti.element_as_gdf.rst

This file was deleted.

6 changes: 6 additions & 0 deletions doc/generated/spaghetti.network.Network.NetworkF.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.NetworkF
==================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.NetworkF
6 changes: 6 additions & 0 deletions doc/generated/spaghetti.network.Network.NetworkG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.NetworkG
==================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.NetworkG
6 changes: 6 additions & 0 deletions doc/generated/spaghetti.network.Network.NetworkK.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.NetworkK
==================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.NetworkK
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.allneighbordistances
==============================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.allneighbordistances
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.compute\_distance\_to\_nodes
======================================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.compute_distance_to_nodes
6 changes: 6 additions & 0 deletions doc/generated/spaghetti.network.Network.compute_snap_dist.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.compute\_snap\_dist
=============================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.compute_snap_dist
6 changes: 6 additions & 0 deletions doc/generated/spaghetti.network.Network.contiguityweights.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.contiguityweights
===========================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.contiguityweights
6 changes: 6 additions & 0 deletions doc/generated/spaghetti.network.Network.count_per_edge.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.count\_per\_edge
==========================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.count_per_edge
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.distancebandweights
=============================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.distancebandweights
6 changes: 6 additions & 0 deletions doc/generated/spaghetti.network.Network.enum_links_node.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.enum\_links\_node
===========================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.enum_links_node
6 changes: 6 additions & 0 deletions doc/generated/spaghetti.network.Network.extractgraph.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.extractgraph
======================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.extractgraph
6 changes: 6 additions & 0 deletions doc/generated/spaghetti.network.Network.loadnetwork.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.loadnetwork
=====================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.loadnetwork
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.nearestneighbordistances
==================================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.nearestneighbordistances
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.node\_distance\_matrix
================================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.node_distance_matrix
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
spaghetti.Network
=================
spaghetti.network.Network
=========================

.. currentmodule:: spaghetti
.. currentmodule:: spaghetti.network

.. autoclass:: Network

Expand Down
6 changes: 6 additions & 0 deletions doc/generated/spaghetti.network.Network.savenetwork.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.savenetwork
=====================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.savenetwork
6 changes: 6 additions & 0 deletions doc/generated/spaghetti.network.Network.segment_edges.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.segment\_edges
========================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.segment_edges
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.simulate\_observations
================================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.simulate_observations
6 changes: 6 additions & 0 deletions doc/generated/spaghetti.network.Network.snapobservations.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
spaghetti.network.Network.snapobservations
==========================================

.. currentmodule:: spaghetti.network

.. automethod:: Network.snapobservations

0 comments on commit 0e07494

Please sign in to comment.