austinorr · austinorr · Mar 19, 2018 · Mar 19, 2018 · Mar 19, 2018 · Mar 19, 2018
diff --git a/.gitignore b/.gitignore
@@ -55,14 +55,7 @@ coverage.xml
 # Django stuff:
 *.log
 
-# Sphinx documentation
-docs/_build
-docs/_static
-docs/_templates
-docs/tutorial/*.rst
-docs/tutorial/*_files
-scratch
-scratch.*
+# IPython Notebook
 .ipynb_checkpoints
 
 # PyBuilder

diff --git a/docs_source/Makefile → docs/_all_docs_source/Makefile b/docs_source/Makefile → docs/_all_docs_source/Makefile
@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _no_git_build
+BUILDDIR      = build
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

diff --git a/docs_source/authors.rst → docs/_all_docs_source/authors.rst b/docs_source/authors.rst → docs/_all_docs_source/authors.rst
diff --git a/docs_source/conf.py → docs/_all_docs_source/conf.py b/docs_source/conf.py → docs/_all_docs_source/conf.py
@@ -24,7 +24,7 @@
 
 # Get the project root dir, which is the parent dir of this
 cwd = os.getcwd()
-project_root = os.path.dirname(cwd)
+project_root = os.path.abspath('../../')#os.path.dirname(cwd)
 
 # Insert the project root dir as the first element in the PYTHONPATH.
 # This lets us ensure that the source package is imported, and that its
@@ -40,8 +40,8 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 
-              'sphinx.ext.napoleon', 
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.napoleon',
               'sphinx.ext.viewcode',
               ]
 
@@ -82,7 +82,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ['_build', 'build']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.

diff --git a/docs_source/contributing.rst → docs/_all_docs_source/contributing.rst b/docs_source/contributing.rst → docs/_all_docs_source/contributing.rst
diff --git a/docs_source/history.rst → docs/_all_docs_source/history.rst b/docs_source/history.rst → docs/_all_docs_source/history.rst
diff --git a/docs_source/index.rst → docs/_all_docs_source/index.rst b/docs_source/index.rst → docs/_all_docs_source/index.rst
diff --git a/docs_source/installation.rst → docs/_all_docs_source/installation.rst b/docs_source/installation.rst → docs/_all_docs_source/installation.rst
diff --git a/docs_source/lsys.rst → docs/_all_docs_source/lsys.rst b/docs_source/lsys.rst → docs/_all_docs_source/lsys.rst
diff --git a/docs_source/lsys.tests.baseline_images.rst → ...ocs_source/lsys.tests.baseline_images.rst b/docs_source/lsys.tests.baseline_images.rst → ...ocs_source/lsys.tests.baseline_images.rst
diff --git a/docs_source/lsys.tests.rst → docs/_all_docs_source/lsys.tests.rst b/docs_source/lsys.tests.rst → docs/_all_docs_source/lsys.tests.rst
diff --git a/docs_source/make.bat → docs/_all_docs_source/make.bat b/docs_source/make.bat → docs/_all_docs_source/make.bat
diff --git a/docs_source/modules.rst → docs/_all_docs_source/modules.rst b/docs_source/modules.rst → docs/_all_docs_source/modules.rst
diff --git a/docs_source/readme.rst → docs/_all_docs_source/readme.rst b/docs_source/readme.rst → docs/_all_docs_source/readme.rst
diff --git a/...sphinxext/ipython_console_highlighting.py → ...sphinxext/ipython_console_highlighting.py b/...sphinxext/ipython_console_highlighting.py → ...sphinxext/ipython_console_highlighting.py
diff --git a/docs_source/sphinxext/ipython_directive.py → ...ocs_source/sphinxext/ipython_directive.py b/docs_source/sphinxext/ipython_directive.py → ...ocs_source/sphinxext/ipython_directive.py
diff --git a/docs_source/sphinxext/plot_directive.py → ...l_docs_source/sphinxext/plot_directive.py b/docs_source/sphinxext/plot_directive.py → ...l_docs_source/sphinxext/plot_directive.py
diff --git a/docs_source/sphinxext/plot_generator.py → ...l_docs_source/sphinxext/plot_generator.py b/docs_source/sphinxext/plot_generator.py → ...l_docs_source/sphinxext/plot_generator.py
diff --git a/docs_source/tutorial/Makefile → docs/_all_docs_source/tutorial/Makefile b/docs_source/tutorial/Makefile → docs/_all_docs_source/tutorial/Makefile
diff --git a/docs_source/tutorial/make.bat → docs/_all_docs_source/tutorial/make.bat b/docs_source/tutorial/make.bat → docs/_all_docs_source/tutorial/make.bat
diff --git a/docs_source/tutorial/tools/nb_to_doc.py → ...l_docs_source/tutorial/tools/nb_to_doc.py b/docs_source/tutorial/tools/nb_to_doc.py → ...l_docs_source/tutorial/tools/nb_to_doc.py
diff --git a/docs_source/tutorial/tools/nbstripout → ...all_docs_source/tutorial/tools/nbstripout b/docs_source/tutorial/tools/nbstripout → ...all_docs_source/tutorial/tools/nbstripout
diff --git a/docs_source/usage.rst → docs/_all_docs_source/usage.rst b/docs_source/usage.rst → docs/_all_docs_source/usage.rst
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -89,10 +89,8 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../readme.html">lsys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
 
 

diff --git a/docs/_modules/lsys/algo.html b/docs/_modules/lsys/algo.html
@@ -90,10 +90,8 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../readme.html">lsys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
 </ul>
 
 

diff --git a/docs/_modules/lsys/bezier.html b/docs/_modules/lsys/bezier.html
@@ -90,10 +90,8 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../readme.html">lsys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
 </ul>
 
 

diff --git a/docs/_modules/lsys/lsys.html b/docs/_modules/lsys/lsys.html
@@ -90,10 +90,8 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../readme.html">lsys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
 </ul>
 
 

diff --git a/docs/_modules/lsys/tests.html b/docs/_modules/lsys/tests.html
@@ -90,10 +90,8 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../readme.html">lsys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
 </ul>
 
 

diff --git a/docs/_modules/lsys/tests/test_algo.html b/docs/_modules/lsys/tests/test_algo.html
@@ -90,10 +90,8 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../readme.html">lsys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>
 
 

diff --git a/docs/_modules/lsys/tests/test_bezier.html b/docs/_modules/lsys/tests/test_bezier.html
@@ -90,10 +90,8 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../readme.html">lsys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>
 
 

diff --git a/docs/_modules/lsys/tests/test_lsys.html b/docs/_modules/lsys/tests/test_lsys.html
@@ -90,10 +90,8 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../readme.html">lsys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>
 
 

diff --git a/docs/_modules/lsys/tests/test_validate.html b/docs/_modules/lsys/tests/test_validate.html
@@ -90,10 +90,8 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../readme.html">lsys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>
 
 

diff --git a/docs/_modules/lsys/tests/test_viz.html b/docs/_modules/lsys/tests/test_viz.html
@@ -90,10 +90,8 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../../readme.html">lsys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>
 
 

diff --git a/docs/_modules/lsys/validate.html b/docs/_modules/lsys/validate.html
@@ -90,10 +90,8 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../readme.html">lsys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
 </ul>
 
 

diff --git a/docs/_modules/lsys/viz.html b/docs/_modules/lsys/viz.html
@@ -90,10 +90,8 @@
 
 
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../readme.html">lsys</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
 </ul>
 
 

diff --git a/docs/_sources/authors.rst.txt~HEAD b/docs/_sources/authors.rst.txt~HEAD
@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst
diff --git a/docs/_sources/authors.rst.txt~master b/docs/_sources/authors.rst.txt~master
@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst
diff --git a/docs/_sources/contributing.rst.txt~HEAD b/docs/_sources/contributing.rst.txt~HEAD
@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst
diff --git a/docs/_sources/contributing.rst.txt~master b/docs/_sources/contributing.rst.txt~master
@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst
diff --git a/docs/_sources/history.rst.txt~HEAD b/docs/_sources/history.rst.txt~HEAD
@@ -0,0 +1 @@
+.. include:: ../HISTORY.rst
diff --git a/docs/_sources/history.rst.txt~master b/docs/_sources/history.rst.txt~master
@@ -0,0 +1 @@
+.. include:: ../HISTORY.rst
diff --git a/docs/_sources/index.rst.txt~HEAD b/docs/_sources/index.rst.txt~HEAD
@@ -0,0 +1,25 @@
+.. lsys documentation master file, created by
+   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to lsys's documentation!
+======================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   readme
+   installation
+   usage
+   contributing
+   authorshistory
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_sources/index.rst.txt~master b/docs/_sources/index.rst.txt~master
@@ -0,0 +1,25 @@
+.. lsys documentation master file, created by
+   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to lsys's documentation!
+======================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   readme
+   installation
+   usage
+   contributing
+   authorshistory
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_sources/installation.rst.txt~HEAD b/docs/_sources/installation.rst.txt~HEAD
@@ -0,0 +1,51 @@
+.. highlight:: shell
+
+============
+Installation
+============
+
+
+Stable release
+--------------
+
+To install lsys, run this command in your terminal:
+
+.. code-block:: console
+
+    $ pip install lsys
+
+This is the preferred method to install lsys, as it will always install the most recent stable release. 
+
+If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+you through the process.
+
+.. _pip: https://pip.pypa.io
+.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
+
+
+From sources
+------------
+
+The sources for lsys can be downloaded from the `Github repo`_.
+
+You can either clone the public repository:
+
+.. code-block:: console
+
+    $ git clone git://github.com/austinorr/lsys
+
+Or download the `tarball`_:
+
+.. code-block:: console
+
+    $ curl  -OL https://github.com/austinorr/lsys/tarball/master
+
+Once you have a copy of the source, you can install it with:
+
+.. code-block:: console
+
+    $ python setup.py install
+
+
+.. _Github repo: https://github.com/austinorr/lsys
+.. _tarball: https://github.com/austinorr/lsys/tarball/master
diff --git a/docs/_sources/installation.rst.txt~master b/docs/_sources/installation.rst.txt~master
@@ -0,0 +1,51 @@
+.. highlight:: shell
+
+============
+Installation
+============
+
+
+Stable release
+--------------
+
+To install lsys, run this command in your terminal:
+
+.. code-block:: console
+
+    $ pip install lsys
+
+This is the preferred method to install lsys, as it will always install the most recent stable release. 
+
+If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+you through the process.
+
+.. _pip: https://pip.pypa.io
+.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
+
+
+From sources
+------------
+
+The sources for lsys can be downloaded from the `Github repo`_.
+
+You can either clone the public repository:
+
+.. code-block:: console
+
+    $ git clone git://github.com/austinorr/lsys
+
+Or download the `tarball`_:
+
+.. code-block:: console
+
+    $ curl  -OL https://github.com/austinorr/lsys/tarball/master
+
+Once you have a copy of the source, you can install it with:
+
+.. code-block:: console
+
+    $ python setup.py install
+
+
+.. _Github repo: https://github.com/austinorr/lsys
+.. _tarball: https://github.com/austinorr/lsys/tarball/master