Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesPHoughton committed Jun 23, 2015
1 parent 771a24a commit 2b9ab2d
Show file tree
Hide file tree
Showing 16 changed files with 38 additions and 10 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/installation.doctree
Binary file not shown.
1 change: 1 addition & 0 deletions docs/_build/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@

<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#installing-via-pip">Installing via pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation.html#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation.html#required-dependencies">Required Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation.html#optional-dependencies">Optional Dependencies</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/_modules/pysd/builder/builder.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@

<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#installing-via-pip">Installing via pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../installation.html#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../installation.html#required-dependencies">Required Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../installation.html#optional-dependencies">Optional Dependencies</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/_modules/pysd/functions/functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@

<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#installing-via-pip">Installing via pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../installation.html#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../installation.html#required-dependencies">Required Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../installation.html#optional-dependencies">Optional Dependencies</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/_modules/pysd/pysd.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@

<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#installing-via-pip">Installing via pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../installation.html#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../installation.html#required-dependencies">Required Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../installation.html#optional-dependencies">Optional Dependencies</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/_sources/installation.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Installation
============
/Users/houghton/Google_Drive/Academic Projects/PYSD/pysd/docs/installation.rst

Installing via pip
------------------
To install the PySD package from the Python package index into an established
Expand Down
18 changes: 16 additions & 2 deletions docs/_build/html/development/translation.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@



<link rel="top" title="PySD 0.3.0 documentation" href="../index.html"/>
<link rel="top" title="PySD 0.3.0 documentation" href="../index.html"/>
<link rel="prev" title="Internal Functions" href="internal_functions.html"/>


<script src="_static/js/modernizr.min.js"></script>
Expand Down Expand Up @@ -69,8 +70,9 @@



<ul>
<ul class="current">
<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#installing-via-pip">Installing via pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation.html#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation.html#required-dependencies">Required Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation.html#optional-dependencies">Optional Dependencies</a></li>
Expand Down Expand Up @@ -109,6 +111,11 @@
<li class="toctree-l2"><a class="reference internal" href="internal_functions.html#building-the-python-model-file">Building the python model file</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Translation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#types">Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="#functions">Functions</a></li>
</ul>
</li>
</ul>


Expand Down Expand Up @@ -233,6 +240,13 @@ <h2>Functions<a class="headerlink" href="#functions" title="Permalink to this he
</div>
<footer>

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">


<a href="internal_functions.html" class="btn btn-neutral" title="Internal Functions" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>


<hr/>

Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@

<ul class="current">
<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#installing-via-pip">Installing via pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#required-dependencies">Required Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#optional-dependencies">Optional Dependencies</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@

<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#installing-via-pip">Installing via pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#required-dependencies">Required Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#optional-dependencies">Optional Dependencies</a></li>
Expand Down
2 changes: 2 additions & 0 deletions docs/_build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@

<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#installing-via-pip">Installing via pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#required-dependencies">Required Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#optional-dependencies">Optional Dependencies</a></li>
Expand Down Expand Up @@ -159,6 +160,7 @@ <h1>PySD<a class="headerlink" href="#pysd" title="Permalink to this headline">¶
<div class="toctree-wrapper compound">
<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#installing-via-pip">Installing via pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#required-dependencies">Required Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#optional-dependencies">Optional Dependencies</a></li>
Expand Down
15 changes: 10 additions & 5 deletions docs/_build/html/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@

<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#installing-via-pip">Installing via pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="#required-dependencies">Required Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="#optional-dependencies">Optional Dependencies</a></li>
Expand All @@ -95,7 +96,6 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="functions.html">User Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="translation.html">Translation</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/developer.html">Developer Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development/developer.html#motivation-the-coming-of-age-of-big-data">Motivation: The (coming of) age of Big Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/developer.html#general-approaches-for-integrating-system-dynamic-models-and-data-analytics">General approaches for integrating system dynamic models and data analytics</a></li>
Expand All @@ -112,6 +112,11 @@
<li class="toctree-l2"><a class="reference internal" href="development/internal_functions.html#building-the-python-model-file">Building the python model file</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="development/translation.html">Translation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development/translation.html#types">Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/translation.html#functions">Functions</a></li>
</ul>
</li>
</ul>


Expand Down Expand Up @@ -151,14 +156,14 @@

<div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<p>/Users/houghton/Google_Drive/Academic Projects/PYSD/pysd/docs/installation.rst
Installing via pip
&#8212;&#8212;&#8212;&#8212;&#8212;&#8212;
To install the PySD package from the Python package index into an established
<div class="section" id="installing-via-pip">
<h2>Installing via pip<a class="headerlink" href="#installing-via-pip" title="Permalink to this headline"></a></h2>
<p>To install the PySD package from the Python package index into an established
Python environment, use the pip command:</p>
<div class="highlight-bash"><div class="highlight"><pre>pip install pysd
</pre></div>
</div>
</div>
<div class="section" id="installing-from-source">
<h2>Installing from source<a class="headerlink" href="#installing-from-source" title="Permalink to this headline"></a></h2>
<p>To install from the source, clone the project with git:</p>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@

<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#installing-via-pip">Installing via pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#required-dependencies">Required Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#optional-dependencies">Optional Dependencies</a></li>
Expand Down

0 comments on commit 2b9ab2d

Please sign in to comment.