Documentation Update

Added API documentation and updated the tutorial links.
pcarolan · Jun 3, 2016 · 1a86a20 · 1a86a20
1 parent 24c2437
commit 1a86a20
Show file tree

Hide file tree

Showing 21 changed files with 90 additions and 30 deletions.
diff --git a/docs/adv_tutorial.rst b/docs/adv_tutorial.rst
@@ -1,9 +1,6 @@
 
-Introduction to Mesa
-====================
-
 Advanced Tutorial
------------------
+=================
 
 Adding visualization
 ~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/batchrunner.rst b/docs/batchrunner.rst
@@ -0,0 +1,5 @@
+Batchrunner
+-----------
+
+.. automodule:: batchrunner
+   :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -18,22 +18,23 @@
 
 
 # Adding mock imports to see if this builds
-from unittest.mock import MagicMock
-
-class Mock(MagicMock):
-    @classmethod
-    def __getattr__(cls, name):
-            return Mock()
-
-MOCK_MODULES = ['numpy', 'pandas']
-sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+# from unittest.mock import MagicMock
+#
+# class Mock(MagicMock):
+#     @classmethod
+#     def __getattr__(cls, name):
+#             return Mock()
+#
+# MOCK_MODULES = ['numpy', 'pandas']
+# sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
 
 # End of mock
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, "../mesa")
 
 # -- General configuration ------------------------------------------------
 
@@ -141,12 +142,12 @@ def __getattr__(cls, name):
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = "images/mesa_logo.png"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+html_favicon = "images/mesa_logo.ico"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/datacollection.rst b/docs/datacollection.rst
@@ -0,0 +1,5 @@
+Data Collection
+---------------
+
+.. automodule:: datacollection
+   :members:
diff --git a/docs/images/mesa_logo.ico b/docs/images/mesa_logo.ico
diff --git a/docs/images/mesa_logo.png b/docs/images/mesa_logo.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -42,12 +42,14 @@ Getting started quickly:
 
 For more help on using Mesa, check out the following resources:
 
-* `Intro to Mesa Tutorial`_
+* `Mesa Introductory Tutorial`_
+* `Mesa Advanced Tutorial`_
 * `Docs`_
 * `Email list`_
 * `PyPI`_
 
-.. _`Intro to Mesa Tutorial` : http://mesa.readthedocs.org/en/latest/intro-tutorial.html
+.. _`Mesa Introductory Tutorial` : http://mesa.readthedocs.org/en/latest/intro_tutorial.html
+.. _`Mesa Advanced Tutorial` : http://mesa.readthedocs.org/en/latest/adv_tutorial.html
 .. _`Docs` : http://mesa.readthedocs.org/en/latest/
 .. _`Email list` : https://groups.google.com/d/forum/projectmesa
 .. _`PyPI` : https://pypi.python.org/pypi/Mesa/
@@ -67,9 +69,21 @@ If you would like to add a feature, please reach out via `ticket`_ or the `email
 .. _`Contributors guide` : https://github.com/projectmesa/mesa/blob/master/CONTRIBUTING.rst
 .. _`Github` : https://github.com/projectmesa/mesa/
 
+API Documentation
+-----------------
 
+.. toctree::
+   :maxdepth 1
+
+   init
+   batchrunner
+   datacollection
+   space
+   time
+   visualization
 
-**Table of Contents**
+Table of Contents
+-----------------
 
 .. toctree::
    :maxdepth: 1
@@ -83,5 +97,4 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
-.. * :ref:`search`
-
+* :ref:`search`
diff --git a/docs/init.rst b/docs/init.rst
@@ -0,0 +1,5 @@
+Base
+----
+
+.. automodule:: __init__
+   :members:
diff --git a/docs/intro_tutorial.rst b/docs/intro_tutorial.rst
@@ -1,9 +1,9 @@
 
-Introduction to Mesa
-====================
-
 Introductory Tutorial
----------------------
+=====================
+
+Tutorial Description
+--------------------
 
 `Mesa <https://github.com/projectmesa/mesa>`__ is a Python framework for
 `agent-based

diff --git a/docs/space.rst b/docs/space.rst
@@ -0,0 +1,5 @@
+Space
+-----
+
+.. automodule:: space
+   :members:
diff --git a/docs/time.rst b/docs/time.rst
@@ -0,0 +1,5 @@
+Time
+----
+
+.. automodule:: time
+   :members:
diff --git a/docs/tutorials/adv_tutorial.ipynb b/docs/tutorials/adv_tutorial.ipynb
@@ -4,15 +4,13 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Introduction to Mesa"
+    "# Advanced Tutorial"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Advanced Tutorial\n",
-    "\n",
     "### Adding visualization\n",
     "\n",
     "So far, we've built a model, run it, and analyzed some output afterwards. However, one of the advantages of agent-based models is that we can often watch them run step by step, potentially spotting unexpected patterns, behaviors or bugs, or developing new intuitions, hypotheses, or insights. Other times, watching a model run can explain it to an unfamiliar audience better than static explanations. Like many ABM frameworks, Mesa allows you to create an interactive visualization of the model. In this section we'll walk through creating a visualization using built-in components, and (for advanced users) how to create a new visualization element.\n",

diff --git a/docs/tutorials/intro_tutorial.ipynb b/docs/tutorials/intro_tutorial.ipynb
@@ -4,14 +4,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Introduction to Mesa"
+    "# Introductory Tutorial"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Introductory Tutorial\n",
+    "## Tutorial Description\n",
     "\n",
     "[Mesa](https://github.com/projectmesa/mesa) is a Python framework for [agent-based modeling](https://en.wikipedia.org/wiki/Agent-based_model).  Getting started with Mesa is easy. In this tutorial, we will walk through creating a simple model and progressively add functionality which will illustrate Mesa's core features.\n",
     "\n",

diff --git a/docs/tutorials/intro_tutorial_files/intro_tutorial_19_1.png b/docs/tutorials/intro_tutorial_files/intro_tutorial_19_1.png
diff --git a/docs/tutorials/intro_tutorial_files/intro_tutorial_21_1.png b/docs/tutorials/intro_tutorial_files/intro_tutorial_21_1.png
diff --git a/docs/tutorials/intro_tutorial_files/intro_tutorial_32_1.png b/docs/tutorials/intro_tutorial_files/intro_tutorial_32_1.png
diff --git a/docs/tutorials/intro_tutorial_files/intro_tutorial_38_1.png b/docs/tutorials/intro_tutorial_files/intro_tutorial_38_1.png
diff --git a/docs/tutorials/intro_tutorial_files/intro_tutorial_42_1.png b/docs/tutorials/intro_tutorial_files/intro_tutorial_42_1.png
diff --git a/docs/tutorials/intro_tutorial_files/intro_tutorial_44_1.png b/docs/tutorials/intro_tutorial_files/intro_tutorial_44_1.png
diff --git a/docs/tutorials/intro_tutorial_files/intro_tutorial_50_1.png b/docs/tutorials/intro_tutorial_files/intro_tutorial_50_1.png
diff --git a/docs/visualization.rst b/docs/visualization.rst
@@ -0,0 +1,26 @@
+Visualization
+-------------
+
+.. automodule:: visualization.__init__
+   :members:
+
+.. automodule:: visualization.ModularVisualization
+   :members:
+
+.. automodule:: visualization.TextVisualization
+   :members:
+
+Modules
+~~~~~~~
+
+.. automodule:: visualization.modules.__init__
+   :members:
+
+.. automodule:: visualization.modules.CanvasGridVisualization
+   :members:
+
+.. automodule:: visualization.modules.ChartVisualization
+   :members:
+
+.. automodule:: visualization.modules.TextVisualization
+   :members: