Documentation Update

Re-organized (again) the API folder and tutorial files. Updated the associated README.md for generating rst from tutorial ipynb. Got rid of the mesa*.rst files that were used previously for generating API documentation.
muethela · Jun 4, 2016 · 2733ce2 · 2733ce2
1 parent 1558547
commit 2733ce2
Show file tree

Hide file tree

Showing 22 changed files with 19 additions and 157 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -14,8 +14,7 @@ Updating docs can be confusing. Here are the basic setups.
   * ```cd tutorials```
 1. Create rST files using nbconvert
   * ```juypter nbconvert --to rST *.ipynb```
-1. Move the rst files to the docs directory
-  * ```mv *.rst ../```
+  * **note** This requires jupyter, all its dependencies and pandoc be installed.
 
 #####Submit a pull request with updates
 1. Create branch (either via branching or fork of repo) -- try to use a descriptive name.
@@ -41,9 +40,3 @@ From this point, you will need to find someone that has access to readthedocs. C
  * ```make html```
 * Autogenerate / update sphninx from docstrings (replace your name as the author:
  * ```sphinx-apidoc -A "Jackie Kazil" -F -o docs mesa/```
-
-
-
-
-
-
diff --git a/docs/apis/api_main.rst b/docs/apis/api_main.rst
@@ -0,0 +1,12 @@
+APIs
+----
+
+.. toctree::
+   :maxdepth: 3
+
+   Base Classes <init>
+   batchrunner
+   datacollection
+   space
+   time
+   visualization
diff --git a/docs/batchrunner.rst → docs/apis/batchrunner.rst b/docs/batchrunner.rst → docs/apis/batchrunner.rst
diff --git a/docs/datacollection.rst → docs/apis/datacollection.rst b/docs/datacollection.rst → docs/apis/datacollection.rst
diff --git a/docs/init.rst → docs/apis/init.rst b/docs/init.rst → docs/apis/init.rst
diff --git a/docs/space.rst → docs/apis/space.rst b/docs/space.rst → docs/apis/space.rst
diff --git a/docs/time.rst → docs/apis/time.rst b/docs/time.rst → docs/apis/time.rst
diff --git a/docs/visualization.rst → docs/apis/visualization.rst b/docs/visualization.rst → docs/apis/visualization.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -69,28 +69,15 @@ 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/
 
-General Documentation
----------------------
 
 .. toctree::
+   :hidden:
    :maxdepth: 1
 
-   Mesa overview <overview>
-   intro_tutorial
-   adv_tutorial
-
-API Documentation
------------------
-
-.. toctree::
-   :maxdepth: 1
-
-   Base Classes <init>
-   batchrunner
-   datacollection
-   space
-   time
-   visualization
+   Mesa Overview <overview>
+   tutorials/intro_tutorial
+   tutorials/adv_tutorial
+   API Documentation <apis/api_main.rst>
 
 Indices and tables
 ==================

diff --git a/docs/intro_tutorial_files/intro_tutorial_19_1.png b/docs/intro_tutorial_files/intro_tutorial_19_1.png
diff --git a/docs/intro_tutorial_files/intro_tutorial_21_1.png b/docs/intro_tutorial_files/intro_tutorial_21_1.png
diff --git a/docs/intro_tutorial_files/intro_tutorial_32_1.png b/docs/intro_tutorial_files/intro_tutorial_32_1.png
diff --git a/docs/intro_tutorial_files/intro_tutorial_38_1.png b/docs/intro_tutorial_files/intro_tutorial_38_1.png
diff --git a/docs/intro_tutorial_files/intro_tutorial_42_1.png b/docs/intro_tutorial_files/intro_tutorial_42_1.png
diff --git a/docs/intro_tutorial_files/intro_tutorial_44_1.png b/docs/intro_tutorial_files/intro_tutorial_44_1.png
diff --git a/docs/intro_tutorial_files/intro_tutorial_50_1.png b/docs/intro_tutorial_files/intro_tutorial_50_1.png
diff --git a/docs/mesa.rst b/docs/mesa.rst
diff --git a/docs/mesa.visualization.modules.rst b/docs/mesa.visualization.modules.rst
diff --git a/docs/mesa.visualization.rst b/docs/mesa.visualization.rst
diff --git a/docs/overview.rst b/docs/overview.rst
@@ -1,5 +1,3 @@
-
-
 Overview of Modules
 ---------------------
 
@@ -44,4 +42,4 @@ Some visualization modules we'll use here include:
 
 * **Grid** visualization,
 * **Chart** display module,
-* The **ModularServer** itself.
+* The **ModularServer** itself.
diff --git a/docs/adv_tutorial.rst → docs/tutorials/adv_tutorial.rst b/docs/adv_tutorial.rst → docs/tutorials/adv_tutorial.rst
diff --git a/docs/intro_tutorial.rst → docs/tutorials/intro_tutorial.rst b/docs/intro_tutorial.rst → docs/tutorials/intro_tutorial.rst