Merge pull request #98 from jGaboardi/new_sphinx_docs

initializing new sphinx docs based on submodule_template
pysal · Sep 4, 2018 · b54fea7 · b54fea7
2 parents b4e3b38 + f66fe44
commit b54fea7
Show file tree

Hide file tree

Showing 393 changed files with 52,034 additions and 312 deletions.
diff --git a/doc/Makefile b/doc/Makefile
@@ -0,0 +1,24 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = spaghetti
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+	rm -rf $(BUILDDIR)/*
+	rm -rf auto_examples/
diff --git a/doc/_build/doctrees/api.doctree b/doc/_build/doctrees/api.doctree
diff --git a/doc/_build/doctrees/environment.pickle b/doc/_build/doctrees/environment.pickle
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.NetworkF.doctree b/doc/_build/doctrees/generated/spaghetti.Network.NetworkF.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.NetworkG.doctree b/doc/_build/doctrees/generated/spaghetti.Network.NetworkG.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.NetworkK.doctree b/doc/_build/doctrees/generated/spaghetti.Network.NetworkK.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.allneighbordistances.doctree b/doc/_build/doctrees/generated/spaghetti.Network.allneighbordistances.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.compute_distance_to_nodes.doctree b/doc/_build/doctrees/generated/spaghetti.Network.compute_distance_to_nodes.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.contiguityweights.doctree b/doc/_build/doctrees/generated/spaghetti.Network.contiguityweights.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.count_per_edge.doctree b/doc/_build/doctrees/generated/spaghetti.Network.count_per_edge.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.distancebandweights.doctree b/doc/_build/doctrees/generated/spaghetti.Network.distancebandweights.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.doctree b/doc/_build/doctrees/generated/spaghetti.Network.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.enum_links_node.doctree b/doc/_build/doctrees/generated/spaghetti.Network.enum_links_node.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.extractgraph.doctree b/doc/_build/doctrees/generated/spaghetti.Network.extractgraph.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.loadnetwork.doctree b/doc/_build/doctrees/generated/spaghetti.Network.loadnetwork.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.nearestneighbordistances.doctree b/doc/_build/doctrees/generated/spaghetti.Network.nearestneighbordistances.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.node_distance_matrix.doctree b/doc/_build/doctrees/generated/spaghetti.Network.node_distance_matrix.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.savenetwork.doctree b/doc/_build/doctrees/generated/spaghetti.Network.savenetwork.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.segment_edges.doctree b/doc/_build/doctrees/generated/spaghetti.Network.segment_edges.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.simulate_observations.doctree b/doc/_build/doctrees/generated/spaghetti.Network.simulate_observations.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.Network.snapobservations.doctree b/doc/_build/doctrees/generated/spaghetti.Network.snapobservations.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkBase.computeenvelope.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkBase.computeenvelope.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkBase.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkBase.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkBase.setbounds.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkBase.setbounds.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkBase.validatedistribution.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkBase.validatedistribution.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkF.computeenvelope.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkF.computeenvelope.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkF.computeobserved.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkF.computeobserved.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkF.computepermutations.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkF.computepermutations.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkF.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkF.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkF.setbounds.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkF.setbounds.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkF.validatedistribution.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkF.validatedistribution.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkG.computeenvelope.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkG.computeenvelope.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkG.computeobserved.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkG.computeobserved.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkG.computepermutations.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkG.computepermutations.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkG.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkG.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkG.setbounds.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkG.setbounds.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkG.validatedistribution.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkG.validatedistribution.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkK.computeenvelope.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkK.computeenvelope.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkK.computeobserved.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkK.computeobserved.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkK.computepermutations.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkK.computepermutations.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkK.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkK.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkK.setbounds.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkK.setbounds.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.NetworkK.validatedistribution.doctree b/doc/_build/doctrees/generated/spaghetti.NetworkK.validatedistribution.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.PointPattern.doctree b/doc/_build/doctrees/generated/spaghetti.PointPattern.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.SimulatedPointPattern.doctree b/doc/_build/doctrees/generated/spaghetti.SimulatedPointPattern.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.analysis.doctree b/doc/_build/doctrees/generated/spaghetti.analysis.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.compute_length.doctree b/doc/_build/doctrees/generated/spaghetti.compute_length.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.dijkstra.doctree b/doc/_build/doctrees/generated/spaghetti.dijkstra.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.dijkstra_mp.doctree b/doc/_build/doctrees/generated/spaghetti.dijkstra_mp.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.ffunction.doctree b/doc/_build/doctrees/generated/spaghetti.ffunction.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.generatetree.doctree b/doc/_build/doctrees/generated/spaghetti.generatetree.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.get_neighbor_distances.doctree b/doc/_build/doctrees/generated/spaghetti.get_neighbor_distances.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.gfunction.doctree b/doc/_build/doctrees/generated/spaghetti.gfunction.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.kfunction.doctree b/doc/_build/doctrees/generated/spaghetti.kfunction.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.NetworkF.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.NetworkF.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.NetworkG.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.NetworkG.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.NetworkK.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.NetworkK.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.allneighbordistances.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.allneighbordistances.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.compute_distance_to_nodes.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.compute_distance_to_nodes.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.contiguityweights.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.contiguityweights.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.count_per_edge.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.count_per_edge.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.distancebandweights.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.distancebandweights.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.enum_links_node.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.enum_links_node.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.extractgraph.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.extractgraph.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.loadnetwork.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.loadnetwork.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.nearestneighbordistances.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.nearestneighbordistances.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.node_distance_matrix.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.node_distance_matrix.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.savenetwork.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.savenetwork.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.segment_edges.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.segment_edges.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.simulate_observations.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.simulate_observations.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.Network.snapobservations.doctree b/doc/_build/doctrees/generated/spaghetti.network.Network.snapobservations.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.PointPattern.doctree b/doc/_build/doctrees/generated/spaghetti.network.PointPattern.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.network.SimulatedPointPattern.doctree b/doc/_build/doctrees/generated/spaghetti.network.SimulatedPointPattern.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.snap_points_on_segments.doctree b/doc/_build/doctrees/generated/spaghetti.snap_points_on_segments.doctree
diff --git a/doc/_build/doctrees/generated/spaghetti.squared_distance_point_segment.doctree b/doc/_build/doctrees/generated/spaghetti.squared_distance_point_segment.doctree
diff --git a/doc/_build/doctrees/index.doctree b/doc/_build/doctrees/index.doctree
diff --git a/doc/_build/doctrees/installation.doctree b/doc/_build/doctrees/installation.doctree
diff --git a/doc/_build/doctrees/references.doctree b/doc/_build/doctrees/references.doctree
diff --git a/doc/_build/html/.buildinfo b/doc/_build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 3bff3090e3be562f255ec6395dbe5289
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/doc/_build/html/_modules/index.html b/doc/_build/html/_modules/index.html
@@ -0,0 +1,145 @@
+<!DOCTYPE html>
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>Overview: module code &#8212; spaghetti v1.1.0 Manual</title>
+    <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pysal-styles.css" type="text/css" />
+    <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+    <script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script>
+    <script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
+    <script type="text/javascript" src="../_static/bootstrap-3.3.7/js/bootstrap.min.js"></script>
+    <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
+    <link rel="shortcut icon" href="../_static/pysal_favicon.ico"/>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+<meta charset='utf-8'>
+<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
+<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
+<meta name="apple-mobile-web-app-capable" content="yes">
+
+  </head><body>
+
+  <div id="navbar" class="navbar navbar-default navbar-fixed-top">
+    <div class="container">
+      <div class="navbar-header">
+        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
+        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </button>
+        <a class="navbar-brand" href="../index.html">
+          spaghetti</a>
+        <span class="navbar-text navbar-version pull-left"><b>1.1.0</b></span>
+      </div>
+
+        <div class="collapse navbar-collapse nav-collapse">
+          <ul class="nav navbar-nav">
+
+                <li><a href="../installation.html">Installation</a></li>
+                <li><a href="../api.html">API</a></li>
+                <li><a href="../references.html">References</a></li>
+
+
+              <li class="dropdown globaltoc-container">
+  <a role="button"
+     id="dLabelGlobalToc"
+     data-toggle="dropdown"
+     data-target="#"
+     href="../index.html">Site <b class="caret"></b></a>
+  <ul class="dropdown-menu globaltoc"
+      role="menu"
+      aria-labelledby="dLabelGlobalToc"><p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../installation.html#stable-version-recommended">Stable Version (Recommended)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../installation.html#development-version">Development Version</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#spaghetti-network">spaghetti.Network</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#spaghetti-networkbase">spaghetti.NetworkBase</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#spaghetti-networkf">spaghetti.NetworkF</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#spaghetti-networkg">spaghetti.NetworkG</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#spaghetti-networkk">spaghetti.NetworkK</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#spaghetti-pointpattern">spaghetti.PointPattern</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#spaghetti-simulatedpointpattern">spaghetti.SimulatedPointPattern</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#spaghetti">spaghetti</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../references.html">References</a></li>
+</ul>
+</ul>
+</li>
+
+                <li class="dropdown">
+  <a role="button"
+     id="dLabelLocalToc"
+     data-toggle="dropdown"
+     data-target="#"
+     href="#">Page <b class="caret"></b></a>
+  <ul class="dropdown-menu localtoc"
+      role="menu"
+      aria-labelledby="dLabelLocalToc"></ul>
+</li>
+
+
+
+
+
+
+          </ul>
+
+
+
+<form class="navbar-form navbar-right" action="../search.html" method="get">
+ <div class="form-group">
+  <input type="text" name="q" class="form-control" placeholder="Search" />
+ </div>
+  <input type="hidden" name="check_keywords" value="yes" />
+  <input type="hidden" name="area" value="default" />
+</form>
+
+        </div>
+    </div>
+  </div>
+
+<div class="container">
+  <div class="row">
+    <div class="col-md-12 content">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="spaghetti/analysis.html">spaghetti.analysis</a></li>
+<li><a href="spaghetti/network.html">spaghetti.network</a></li>
+<li><a href="spaghetti/util.html">spaghetti.util</a></li>
+</ul>
+
+    </div>
+
+  </div>
+</div>
+<footer class="footer">
+  <div class="container">
+    <p class="pull-right">
+      <a href="#">Back to top</a>
+
+        <br/>
+
+
+    </p>
+    <p>
+        &copy; Copyright 2018, pysal developers.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.6.<br/>
+    </p>
+  </div>
+</footer>
+  </body>
+</html>