Merge pull request #3453 from bashtage/website-fixes

DOC: Small doc fixes
statsmodels · Feb 7, 2017 · 402d29e · 402d29e
2 parents bfd8d2b + 2b6c432
commit 402d29e
Show file tree

Hide file tree

Showing 16 changed files with 27 additions and 25 deletions.
diff --git a/docs/make.bat b/docs/make.bat
@@ -7,7 +7,7 @@ if "%SPHINXBUILD%" == "" (
 )
 set BUILDDIR=build
 set TOOLSPATH=../tools
-set EXAMPLEBUILD=examples_rst.py
+set DATASETBUILD=dataset_rst.py
 set NOTEBOOKBUILD=nbgenerate.py
 set FOLDTOC=fold_toc.py
 set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
@@ -48,6 +48,8 @@ if "%1" == "html" (
     REM python %TOOLSPATH%/%EXAMPLEBUILD%
 	echo python %TOOLSPATH%/%NOTEBOOKBUILD% --execute=True --allow_errors=True
     python %TOOLSPATH%/%NOTEBOOKBUILD% --execute=True --allow_errors=True
+    echo python %TOOLSPATH%/%DATASETBUILD%
+    python %TOOLSPATH%/%DATASETBUILD%
 	echo %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
 	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
 	if errorlevel 1 exit /b 1

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -302,10 +302,10 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-        'numpy' : ('http://docs.scipy.org/doc/numpy/', None),
-        'python' : ('http://docs.python.org/3.2', None),
+        'numpy' : ('https://docs.scipy.org/doc/numpy/', None),
+        'python' : ('https://docs.python.org/3.2', None),
         'pydagogue' : ('http://matthew-brett.github.io/pydagogue/', None),
-        'patsy' : ('http://patsy.readthedocs.org/en/latest/', None),
+        'patsy' : ('http://patsy.readthedocs.io/en/latest/', None),
         'pandas' : ('http://pandas.pydata.org/pandas-docs/stable/', None),
         }
 

diff --git a/docs/source/imputation.rst b/docs/source/imputation.rst
@@ -45,5 +45,5 @@ Implementation Details
 ----------------------
 
 Internally, this function uses
-`pandas.isnull <pandas:http://pandas.pydata.org/pandas-docs/stable/missing_data.html#working-with-missing-data>`_.
+`pandas.isnull <http://pandas.pydata.org/pandas-docs/stable/missing_data.html#working-with-missing-data>`_.
 Anything that returns True from this function will be treated as missing data.
diff --git a/docs/source/iolib.rst b/docs/source/iolib.rst
@@ -14,7 +14,7 @@ Users can also leverage the powerful input/output functions provided by :ref:`pa
 Examples
 --------
 
-    `SimpleTable: Basic example <examples/notebooks/generated/example_wls.html#ols-vs-wls>`__
+    `SimpleTable: Basic example <examples/notebooks/generated/wls.html#ols-vs-wls>`__
 
 Module Reference
 ----------------

diff --git a/docs/source/plots/graphics_month_plot.py b/docs/source/plots/graphics_month_plot.py
@@ -6,6 +6,6 @@
 dta = dta.set_index('YEAR').T.unstack()
 dates = pd.to_datetime(list(map(lambda x : '-'.join(x) + '-1', dta.index.values)))
 
-dta.index = pd.DatetimeIndex(list(dates), freq='M')
+dta.index = pd.DatetimeIndex(list(dates), freq='MS')
 dta.name = 'temp'
 fig = sm.graphics.tsa.month_plot(dta)
diff --git a/docs/source/release/version0.7.rst b/docs/source/release/version0.7.rst
@@ -220,7 +220,7 @@ Development summary and credits
 
 .. note::
 
-Thanks to all of the contributors for the 0.7 release:
+  Thanks to all of the contributors for the 0.7 release:
 
 .. note::
 

diff --git a/docs/source/release/version0.8.rst b/docs/source/release/version0.8.rst
@@ -150,7 +150,7 @@ Local FDR, multiple testing #2297 (Kerby Shedden)
 
 Mediation Analysis #2352 (Kerby Shedden)
 
-Confidence intervals for multinomial proportions #3162 (Sébastien Lerique, Josef Perktold)
+Confidence intervals for multinomial proportions #3162 (Sebastien Lerique, Josef Perktold)
 
 other:
 

diff --git a/docs/source/rlm.rst b/docs/source/rlm.rst
@@ -98,7 +98,6 @@ Scale
     Huber
     HuberScale
     mad
-    huber
     hubers_scale
     stand_mad
 
diff --git a/docs/source/statespace.rst b/docs/source/statespace.rst
@@ -165,7 +165,7 @@ The `UnobservedComponents` class is another example of a statespace model.
    structural.UnobservedComponents
    structural.UnobservedComponentsResults
 
-For examples of the use of this model, see the `example notebook <examples/notebooks/generated/statespace_structural_harvey_jaeger_notebook.html>`__ or a notebook on using the unobserved components model to `decompose a time series into a trend and cycle <examples/notebooks/generated/statespace_cycles_notebook.html>`__ or the very brief code snippet below:
+For examples of the use of this model, see the `example notebook <examples/notebooks/generated/statespace_structural_harvey_jaeger_notebook.html>`__ or a notebook on using the unobserved components model to `decompose a time series into a trend and cycle <examples/notebooks/generated/statespace_cycles.html>`__ or the very brief code snippet below:
 
 .. code-block:: python
 

diff --git a/docs/source/stats.rst b/docs/source/stats.rst
@@ -210,7 +210,7 @@ to one way ANOVA, but still in developement
 
    pairwise_tukeyhsd
 
-.. currentmuodule:: statsmodels.stats.multitest
+.. currentmodule:: statsmodels.stats.multitest
 
 .. autosummary::
    :toctree: generated/

diff --git a/docs/source/tsa.rst b/docs/source/tsa.rst
@@ -212,10 +212,11 @@ Time Series Filters
 TSA Tools
 """""""""
 
+.. currentmodule:: statsmodels.tsa
+
 .. autosummary::
    :toctree: generated/
 
-   tsatools.add_constant
    tsatools.add_trend
    tsatools.detrend
    tsatools.lagmat

diff --git a/docs/themes/statsmodels/indexsidebar.html b/docs/themes/statsmodels/indexsidebar.html
@@ -27,5 +27,5 @@ <h3>Participate</h3>
 <p style="font-size:1em">
     Grab the source from <a href="https://github.com/statsmodels/statsmodels/">Github</a>.
     Report bugs to the <a href="https://github.com/statsmodels/statsmodels/issues">Issue Tracker</a>.
-    Have a look at our <a href="{{ pathto('dev/index') }}">Developer</a> and <a href = "{{ pathto('dev/roadmap_todo') }}">Get Involved</a> Pages.
+    Have a look at our <a href="{{ pathto('dev/index') }}">Developer</a> Pages.
 </p>
diff --git a/docs/themes/statsmodels/layout.html b/docs/themes/statsmodels/layout.html
@@ -6,8 +6,8 @@
     #}
 {% extends "basic/layout.html" %}
 {% block extrahead %}
-<link rel="stylesheet" href="../../_static/facebox.css" type="text/css" />
-<link rel="stylesheet" href="../_static/examples.css" type="text/css" />
+<link rel="stylesheet" href="{{ pathto('_static/examples.css', 1) }}" type="text/css" />
+<link rel="stylesheet" href="{{ pathto('_static/facebox.css', 1) }}" type="text/css" />
 <script type="text/javascript" src="{{pathto('_static/scripts.js', 1) }}">
 </script>
 <script type="text/javascript" src="{{pathto('_static/facebox.js', 1) }}">

diff --git a/statsmodels/stats/correlation_tools.py b/statsmodels/stats/correlation_tools.py
@@ -792,17 +792,17 @@ def corr_thresholded(data, minabs=None, max_elt=1e7):
 
     Notes
     -----
-    This is an alternative to C = np.corrcoef(data); C *= (np.abs(C)
+    This is an alternative to C = np.corrcoef(data); C \*= (np.abs(C)
     >= absmin), suitable for very tall data matrices.
 
     If the data are jointly Gaussian, the marginal sampling
     distributions of the elements of the sample correlation matrix are
     approximately Gaussian with standard deviation 1 / sqrt(n).  The
-    default value of `minabs` is thus equal to 1 standard error, which
+    default value of ``minabs`` is thus equal to 1 standard error, which
     will set to zero approximately 68% of the estimated correlation
     coefficients for which the population value is zero.
 
-    No intermediate matrix with more than `max_elt` values will be
+    No intermediate matrix with more than ``max_elt`` values will be
     constructed.  However memory use could still be high if a large
     number of correlation values exceed `minabs` in magnitude.
 

diff --git a/statsmodels/stats/multitest.py b/statsmodels/stats/multitest.py
@@ -351,13 +351,13 @@ def fdrcorrection_twostage(pvals, alpha=0.05, method='bky', iter=False,
     alpha : float
         error rate
     method : {'bky', 'bh')
-         see Notes for details
+        see Notes for details
 
-        'bky' : implements the procedure in Definition 6 of Benjamini, Krieger
+        * 'bky' - implements the procedure in Definition 6 of Benjamini, Krieger
            and Yekuteli 2006
-        'bh' : implements the two stage method of Benjamini and Hochberg
+        * 'bh' - the two stage method of Benjamini and Hochberg
 
-    iter ; bool
+    iter : bool
 
     Returns
     -------

diff --git a/statsmodels/tools/tools.py b/statsmodels/tools/tools.py
@@ -244,12 +244,12 @@ def add_constant(data, prepend=True, has_constant='skip'):
     Parameters
     ----------
     data : array-like
-        `data` is the column-ordered design matrix
+        ``data`` is the column-ordered design matrix
     prepend : bool
         If true, the constant is in the first column.  Else the constant is
         appended (last column).
     has_constant : str {'raise', 'add', 'skip'}
-        Behavior if ``data'' already has a constant. The default will return
+        Behavior if ``data`` already has a constant. The default will return
         data without adding another constant. If 'raise', will raise an
         error if a constant is present. Using 'add' will duplicate the
         constant, if one is present.