Merge pull request #3458 from bashtage/add-module-tags-to-docs

DOC: Add module tags to docs
statsmodels · Feb 8, 2017 · 75edeb6 · 75edeb6
2 parents 72e2673 + 4faad6c
commit 75edeb6
Show file tree

Hide file tree

Showing 33 changed files with 179 additions and 82 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -58,6 +58,9 @@ notebooks:
 	$(TOOLSPATH)$(NOTEBOOKBUILD) --execute=True --allow_errors=True
 
 html:
+    # make directories for images
+	@echo "Make static directory for images"
+	mkdir -p $(BUILDDIR)/html/_static
 	# generate the examples rst files
 	@echo "Generating reST from examples folder"
 	#$(TOOLSPATH)$(EXAMPLEBUILD)

diff --git a/docs/make.bat b/docs/make.bat
@@ -46,6 +46,8 @@ if "%1" == "clean" (
 
 if "%1" == "html" (
     REM python %TOOLSPATH%/%EXAMPLEBUILD%
+    echo mkdir %BUILDDIR%\html\_static
+    mkdir %BUILDDIR%\html\_static
 	echo python %TOOLSPATH%/%NOTEBOOKBUILD% --execute=True --allow_errors=True
     python %TOOLSPATH%/%NOTEBOOKBUILD% --execute=True --allow_errors=True
     echo python %TOOLSPATH%/%DATASETBUILD%

diff --git a/docs/source/about.rst b/docs/source/about.rst
@@ -1,3 +1,4 @@
+.. module:: statsmodels
 .. currentmodule:: statsmodels
 
 *****************

diff --git a/docs/source/anova.rst b/docs/source/anova.rst
@@ -33,6 +33,8 @@ A more detailed example can be found here:
 Module Reference
 ----------------
 
+.. module:: statsmodels.stats.anova
+
 .. autosummary::
    :toctree: generated/
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -25,17 +25,23 @@
 
 # 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.doctest',
-              'sphinx.ext.intersphinx', 'sphinx.ext.todo',
-              # 'sphinx.ext.imgmath',
-              'sphinx.ext.pngmath', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary',
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.doctest',
+              'sphinx.ext.intersphinx',
+              'sphinx.ext.todo',
+              # 'sphinx.ext.mathjax', # One of mathjax, pngmath or imgmath
+              # 'sphinx.ext.imgmath'
+              'sphinx.ext.pngmath',
+              'sphinx.ext.viewcode',
+              'sphinx.ext.autosummary',
               'sphinx.ext.inheritance_diagram',
               'matplotlib.sphinxext.plot_directive',
               'matplotlib.sphinxext.only_directives',
               'IPython.sphinxext.ipython_console_highlighting',
               'IPython.sphinxext.ipython_directive',
               'github',  # for GitHub links,
-              'numpydoc',
+              'numpydoc',  # numpydoc or napoleon, but not both
+              # 'sphinx.ext.napoleon'
               ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -52,7 +58,7 @@
 
 # General information about the project.
 project = u'statsmodels'
-copyright = u'2009-2016, Josef Perktold, Skipper Seabold, Jonathan Taylor, statsmodels-developers'
+copyright = u'2009-2017, Josef Perktold, Skipper Seabold, Jonathan Taylor, statsmodels-developers'
 
 
 autosummary_generate = True
@@ -264,7 +270,7 @@
 epub_title = u'statsmodels'
 epub_author = u'Josef Perktold, Skipper Seabold'
 epub_publisher = u'Josef Perktold, Skipper Seabold'
-epub_copyright = u'2009-2016, Josef Perktold, Skipper Seabold, Jonathan Taylor, statsmodels-developers'
+epub_copyright = u'2009-2017, Josef Perktold, Skipper Seabold, Jonathan Taylor, statsmodels-developers'
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.

diff --git a/docs/source/contingency_tables.rst b/docs/source/contingency_tables.rst
@@ -274,6 +274,7 @@ methods and attributes.
 Module Reference
 ----------------
 
+.. module:: statsmodels.stats.contingency_tables
 .. currentmodule:: statsmodels.stats.contingency_tables
 
 .. autosummary::

diff --git a/docs/source/dev/internal.rst b/docs/source/dev/internal.rst
@@ -20,6 +20,7 @@ These are the base classes for both the estimation models and the results.
 They are not directly useful, but layout the structure of the subclasses and
 define some common methods.
 
+.. module:: statsmodels.base.model
 .. currentmodule:: statsmodels.base.model
 
 .. autosummary::
@@ -33,6 +34,7 @@ define some common methods.
    ResultMixin
    GenericLikelihoodModelResults
 
+.. module:: statsmodels.stats.contrast
 .. currentmodule:: statsmodels.stats.contrast
 
 .. autosummary::

diff --git a/docs/source/discretemod.rst b/docs/source/discretemod.rst
@@ -60,6 +60,8 @@ General references for this class of models are::
 Module Reference
 ----------------
 
+.. module:: statsmodels.discrete.discrete_model
+
 The specific model classes are:
 
 .. autosummary::

diff --git a/docs/source/distributions.rst b/docs/source/distributions.rst
@@ -1,3 +1,4 @@
+.. module:: statsmodels.sandbox.distributions
 .. currentmodule:: statsmodels.sandbox.distributions
 
 .. _distributions:
@@ -12,6 +13,7 @@ distributions.
 Empirical Distributions
 -----------------------
 
+.. module:: statsmodels.distributions.empirical_distribution
 .. currentmodule:: statsmodels.distributions.empirical_distribution
 
 .. autosummary::
@@ -25,6 +27,7 @@ Distribution Extras
 -------------------
 
 
+.. module:: statsmodels.sandbox.distributions.extras
 .. currentmodule:: statsmodels.sandbox.distributions.extras
 
 *Skew Distributions*
@@ -65,6 +68,7 @@ distribution from a monotonic transformation, `TransfTwo_gen` can use hump-shape
 or u-shaped transformation, such as abs or square. The remaining objects are
 special cases.
 
+.. module:: statsmodels.sandbox.distributions.transformed
 .. currentmodule:: statsmodels.sandbox.distributions.transformed
 
 .. autosummary::

diff --git a/docs/source/duration.rst b/docs/source/duration.rst
@@ -1,3 +1,4 @@
+.. module:: statsmodels.duration
 .. currentmodule:: statsmodels.duration
 
 
@@ -199,6 +200,7 @@ References for Cox proportional hazards regression model::
 Module Reference
 ----------------
 
+.. module:: statsmodels.duration.survfunc
 .. currentmodule:: statsmodels.duration.survfunc
 
 The class for working with survival distributions is:
@@ -208,6 +210,7 @@ The class for working with survival distributions is:
 
    SurvfuncRight
 
+.. module:: statsmodels.duration.hazard_regression
 .. currentmodule:: statsmodels.duration.hazard_regression
 
 The proportional hazards regression model class is:

diff --git a/docs/source/emplike.rst b/docs/source/emplike.rst
@@ -60,6 +60,8 @@ Examples
 Module Reference
 ----------------
 
+.. module:: statsmodels.emplike
+
 .. autosummary::
    :toctree: generated/
 

diff --git a/docs/source/gee.rst b/docs/source/gee.rst
@@ -59,6 +59,8 @@ References
 Module Reference
 ----------------
 
+.. module:: statsmodels.genmod.generalized_estimating_equations
+
 Model Class
 ^^^^^^^^^^^
 
@@ -81,6 +83,7 @@ Dependence Structures
 
 The dependence structures currently implemented are
 
+.. module:: statsmodels.genmod.cov_struct
 .. currentmodule:: statsmodels.genmod.cov_struct
 
 .. autosummary::
@@ -99,6 +102,7 @@ Families
 
 The distribution families are the same as for GLM, currently implemented are
 
+.. module:: statsmodels.genmod.families.family
 .. currentmodule:: statsmodels.genmod.families.family
 
 .. autosummary::

diff --git a/docs/source/glm.rst b/docs/source/glm.rst
@@ -114,6 +114,8 @@ References
 Module Reference
 ----------------
 
+.. module:: statsmodels.genmod.generalized_linear_model
+
 Model Class
 ^^^^^^^^^^^
 
@@ -137,6 +139,7 @@ Families
 
 The distribution families currently implemented are
 
+.. module:: statsmodels.genmod.families.family
 .. currentmodule:: statsmodels.genmod.families.family
 
 .. autosummary::
@@ -166,6 +169,7 @@ available link functions can be obtained by
 
     >>> sm.families.family.<familyname>.links
 
+.. module:: statsmodels.genmod.families.links
 .. currentmodule:: statsmodels.genmod.families.links
 
 .. autosummary::

diff --git a/docs/source/gmm.rst b/docs/source/gmm.rst
@@ -27,6 +27,8 @@ only the moment conditions, `momcond` have to be defined.
 Module Reference
 """"""""""""""""
 
+.. module:: statsmodels.sandbox.regression.gmm
+
 .. autosummary::
    :toctree: generated/
 

diff --git a/docs/source/imputation.rst b/docs/source/imputation.rst
@@ -1,3 +1,4 @@
+.. module:: statsmodels.imputation.mice
 .. currentmodule:: statsmodels.imputation.mice
 
 .. _imputation:

diff --git a/docs/source/iolib.rst b/docs/source/iolib.rst
@@ -19,6 +19,8 @@ Examples
 Module Reference
 ----------------
 
+.. module:: statsmodels.iolib
+
 
 .. autosummary::
    :toctree: generated/

diff --git a/docs/source/miscmodels.rst b/docs/source/miscmodels.rst
@@ -1,5 +1,7 @@
 
 
+
+.. module:: statsmodels.miscmodels
 .. currentmodule:: statsmodels.miscmodels
 
 
@@ -28,6 +30,7 @@ another example can be seen in the zero inflated Poisson model, miscmodels.count
 Count Models :mod:`count`
 --------------------------
 
+.. module:: statsmodels.miscmodels.count
 .. currentmodule:: statsmodels.miscmodels.count
 
 .. autosummary::
@@ -45,6 +48,7 @@ method for the loglikelihood. All result statistics are inherited from the gener
 likelihood model and result classes. The results have been checked against R for a
 simple case.
 
+.. module:: statsmodels.miscmodels.tmodel
 .. currentmodule:: statsmodels.miscmodels.tmodel
 
 .. autosummary::

diff --git a/docs/source/mixed_linear.rst b/docs/source/mixed_linear.rst
@@ -161,6 +161,8 @@ users:
 Module Reference
 ----------------
 
+.. module:: statsmodels.regression.mixed_linear_model
+
 The model class is:
 
 .. autosummary::

diff --git a/docs/source/multivariate.rst b/docs/source/multivariate.rst
@@ -1,3 +1,4 @@
+.. module:: statsmodels.multivariate
 .. currentmodule:: statsmodels.multivariate
 
 .. _multivariate:
@@ -12,8 +13,11 @@ This section includes methods and algorithms from multivariate statistics.
 Principal Component Analysis
 ----------------------------
 
+.. module:: statsmodels.multivariate.pca
+.. currentmodule:: statsmodels.multivariate.pca
+
 .. autosummary::
    :toctree: generated/
 
-   pca.PCA
-   pca.pca
+   PCA
+   pca
diff --git a/docs/source/nonparametric.rst b/docs/source/nonparametric.rst
@@ -84,6 +84,8 @@ References
 Module Reference
 ----------------
 
+.. module:: statsmodels.nonparametric
+
 The public functions and classes are
 
 .. autosummary::

diff --git a/docs/source/regression.rst b/docs/source/regression.rst
@@ -127,6 +127,8 @@ wendog : array
 Module Reference
 ----------------
 
+.. module:: statsmodels.regression.linear_model
+
 Model Classes
 ^^^^^^^^^^^^^
 
@@ -139,13 +141,15 @@ Model Classes
    GLSAR
    yule_walker
 
+.. module:: statsmodels.regression.quantile_regression
 .. currentmodule:: statsmodels.regression.quantile_regression
 
 .. autosummary::
    :toctree: generated/
 
    QuantReg
 
+.. module:: statsmodels.regression.recursive_ls
 .. currentmodule:: statsmodels.regression.recursive_ls
 
 .. autosummary::

diff --git a/docs/source/rlm.rst b/docs/source/rlm.rst
@@ -48,9 +48,12 @@ References
 Module Reference
 ----------------
 
+.. module:: statsmodels.robust
+
 Model Classes
 ^^^^^^^^^^^^^
 
+.. module:: statsmodels.robust.robust_linear_model
 .. currentmodule:: statsmodels.robust.robust_linear_model
 
 .. autosummary::
@@ -71,6 +74,7 @@ Model Results
 Norms
 ^^^^^
 
+.. module:: statsmodels.robust.norms
 .. currentmodule:: statsmodels.robust.norms
 
 .. autosummary::
@@ -90,6 +94,7 @@ Norms
 Scale
 ^^^^^
 
+.. module:: statsmodels.robust.scale
 .. currentmodule:: statsmodels.robust.scale
 
 .. autosummary::

diff --git a/docs/source/rlm_techn1.rst b/docs/source/rlm_techn1.rst
@@ -1,3 +1,4 @@
+.. module:: statsmodels.rlm
 .. currentmodule:: statsmodels.rlm