Merge pull request statsmodels#1292 from vincentarelbundock/master

DOC: cleanup examples folder and webpage
PierreBdR · Jan 6, 2014 · 013c8ee · 013c8ee
2 parents d467719 + a9cc574
commit 013c8ee
Show file tree

Hide file tree

Showing 63 changed files with 3,789 additions and 1,490 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -52,13 +52,13 @@ cleancache:
 html:
 	# generate the examples rst files
 	@echo "Generating reST from examples folder"
-	$(TOOLSPATH)$(EXAMPLEBUILD)
+	#$(TOOLSPATH)$(EXAMPLEBUILD)
 	@echo "Generating notebooks from examples/notebooks folder" 
 	$(TOOLSPATH)$(NOTEBOOKBUILD)
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	$(TOOLSPATH)$(EXAMPLEBUILD)
+	#$(TOOLSPATH)$(EXAMPLEBUILD)
 	$(TOOLSPATH)$(FOLDTOC) $(BUILDDIR)/html/index.html
-	$(TOOLSPATH)$(FOLDTOC) $(BUILDDIR)/html/examples/index.html ../_static
+	#$(TOOLSPATH)$(FOLDTOC) $(BUILDDIR)/html/examples/index.html ../_static
 	$(TOOLSPATH)$(FOLDTOC) $(BUILDDIR)/html/dev/index.html ../_static
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst
@@ -4,32 +4,17 @@ Statsmodels Examples
 ====================
 
 This page provides a series of examples, tutorials and recipes to help you get
-started with ``statsmodels``.
+started with ``statsmodels``. Each of the examples shown here is made available
+as an IPython Notebook and as a plain python script on the `statsmodels github
+repository <https://github.com/statsmodels/statsmodels/tree/master/examples>`_. 
 
-Each of these examples is also made available in
-IPython Notebook format on the `examples wiki page
-<https://github.com/statsmodels/statsmodels/wiki/Examples:-user-contributions>`_.
-Of course, you can edit the examples wiki page freely; please add any example,
-tutorial or cool `statsmodels` trick you feel is worth sharing. Thanks for
-helping us make this resource more useful!
-
-The script files for these examples and the notebooks are available in the
-top level examples folder in the source distribution.
-
-`Examples wiki page <https://github.com/statsmodels/statsmodels/wiki/Examples:-user-contributions>`_
+We also encourage users to submit their own examples, tutorials or cool
+`statsmodels` trick to the `Examples wiki page
+<https://github.com/statsmodels/statsmodels/wiki/Examples>`_
 
 The Examples
 ------------
 
-.. toctree::
-   :maxdepth: 3
-   :glob:
-
-   generated/*
-
-Notebook Examples
------------------
-
 .. toctree::
    :maxdepth: 3
    :glob:

diff --git a/examples/example_discrete.py b/examples/example_discrete.py
diff --git a/examples/example_formula_glm.py b/examples/example_formula_glm.py
diff --git a/examples/example_glm.py b/examples/example_glm.py