Merge pull request statsmodels#8886 from bashtage/fix-doc-notebook-links

bashtage · web-flow · commit 77cb06632039 · 2023-05-18T00:23:50.000+01:00
DOC: Correct links to notebooks
diff --git a/docs/source/anova.rst b/docs/source/anova.rst
@@ -30,7 +30,7 @@ Examples
 
 A more detailed example for `anova_lm` can be found here:
 
-*  `ANOVA <examples/notebooks/generated/interactions_anova.html>`__
+*  `ANOVA <examples/notebooks/generated/interactions_anova.ipynb>`_
 
 Module Reference
 ----------------
diff --git a/docs/source/discretemod.rst b/docs/source/discretemod.rst
@@ -36,8 +36,8 @@ Examples
 Detailed examples can be found here:
 
 
-* `Overview <examples/notebooks/generated/discrete_choice_overview.html>`__
-* `Examples <examples/notebooks/generated/discrete_choice_example.html>`__
+* `Overview <examples/notebooks/generated/discrete_choice_overview.ipynb>`_
+* `Examples <examples/notebooks/generated/discrete_choice_example.ipynb>`_
 
 Technical Documentation
 -----------------------
diff --git a/docs/source/glm.rst b/docs/source/glm.rst
@@ -28,8 +28,8 @@ Examples
 
 Detailed examples can be found here:
 
-* `GLM <examples/notebooks/generated/glm.html>`__
-* `Formula <examples/notebooks/generated/glm_formula.html>`__
+* `GLM <examples/notebooks/generated/glm.ipynb>`_
+* `Formula <examples/notebooks/generated/glm_formula.ipynb>`_
 
 Technical Documentation
 -----------------------
diff --git a/docs/source/large_data.rst b/docs/source/large_data.rst
@@ -27,7 +27,7 @@ A current limitation of this approach is that it generally does not support
 design matrix (known as `exog`) in statsmodels, is a little challenging.
 
 A detailed example is available
-`here <examples/notebooks/generated/distributed_estimation.html>`_.
+`here <examples/notebooks/generated/distributed_estimation.ipynb>`_.
 
 .. autosummary::
    :toctree: generated/
diff --git a/docs/source/mixed_linear.rst b/docs/source/mixed_linear.rst
@@ -91,7 +91,7 @@ Examples
 
 Detailed examples can be found here
 
-* `Mixed LM <examples/notebooks/generated/mixed_lm_example.html>`__
+* `Mixed LM <examples/notebooks/generated/mixed_lm_example.ipynb>`_
 
 There are some notebook examples on the Wiki:
 `Wiki notebooks for MixedLM <https://github.com/statsmodels/statsmodels/wiki/Examples#linear-mixed-models>`_
diff --git a/docs/source/regression.rst b/docs/source/regression.rst
@@ -33,11 +33,11 @@ Examples
 Detailed examples can be found here:
 
 
-* `OLS <examples/notebooks/generated/ols.html>`__
-* `WLS <examples/notebooks/generated/wls.html>`__
-* `GLS <examples/notebooks/generated/gls.html>`__
-* `Recursive LS <examples/notebooks/generated/recursive_ls.html>`__
-* `Rolling LS <examples/notebooks/generated/rolling_ls.html>`__
+* `OLS <examples/notebooks/generated/ols.ipynb>`_
+* `WLS <examples/notebooks/generated/wls.ipynb>`_
+* `GLS <examples/notebooks/generated/gls.ipynb>`_
+* `Recursive LS <examples/notebooks/generated/recursive_ls.ipynb>`_
+* `Rolling LS <examples/notebooks/generated/rolling_ls.ipynb>`_
 
 Technical Documentation
 -----------------------
diff --git a/docs/source/rlm.rst b/docs/source/rlm.rst
@@ -27,8 +27,8 @@ Examples
 
 Detailed examples can be found here:
 
-* `Robust Models 1 <examples/notebooks/generated/robust_models_0.html>`__
-* `Robust Models 2 <examples/notebooks/generated/robust_models_1.html>`__
+* `Robust Models 1 <examples/notebooks/generated/robust_models_0.ipynb>`_
+* `Robust Models 2 <examples/notebooks/generated/robust_models_1.ipynb>`_
 
 Technical Documentation
 -----------------------
diff --git a/docs/source/statespace.rst b/docs/source/statespace.rst
@@ -117,7 +117,7 @@ arbitrary trend polynomials.
    sarimax.SARIMAXResults
 
 For an example of the use of this model, see the
-`SARIMAX example notebook <examples/notebooks/generated/statespace_sarimax_stata.html>`__
+`SARIMAX example notebook <examples/notebooks/generated/statespace_sarimax_stata.ipynb>`_
 or the very brief code snippet below:
 
 
@@ -168,7 +168,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.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:
+For examples of the use of this model, see the `example notebook <examples/notebooks/generated/statespace_structural_harvey_jaeger.ipynb>`_ or a notebook on using the unobserved components model to `decompose a time series into a trend and cycle <examples/notebooks/generated/statespace_cycles.ipynb>`_ or the very brief code snippet below:
 
 .. code-block:: python
 
@@ -215,7 +215,7 @@ The `VARMAX` class is an example of a multivariate statespace model.
    varmax.VARMAX
    varmax.VARMAXResults
 
-For an example of the use of this model, see the `VARMAX example notebook <examples/notebooks/generated/statespace_varmax.html>`__ or the very brief code snippet below:
+For an example of the use of this model, see the `VARMAX example notebook <examples/notebooks/generated/statespace_varmax.ipynb>`_ or the very brief code snippet below:
 
 .. code-block:: python
 
@@ -293,7 +293,7 @@ observed variables
    dynamic_factor.DynamicFactorResults
 
 For an example of the use of the `DynamicFactor` model, see the
-`Dynamic Factor example notebook <examples/notebooks/generated/statespace_dfm_coincident.html>`__ 
+`Dynamic Factor example notebook <examples/notebooks/generated/statespace_dfm_coincident.ipynb>`_
 
 Linear Exponential Smoothing Models
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -382,7 +382,7 @@ likelihood fitting functionality for estimation and results output.
    mlemodel.PredictionResults
 
 For a basic example demonstrating creating and estimating a custom state space
-model, see the `Local Linear Trend example notebook <examples/notebooks/generated/statespace_local_linear_trend.html>`__.
+model, see the `Local Linear Trend example notebook <examples/notebooks/generated/statespace_local_linear_trend.ipynb>`_.
 For a more sophisticated example, see the source code for the `SARIMAX` and
 `SARIMAXResults` classes, which are built by extending `MLEModel` and
 `MLEResults`.
diff --git a/docs/source/stats.rst b/docs/source/stats.rst
@@ -465,7 +465,7 @@ Rates
 Statistical functions for rates. This currently includes hypothesis tests for
 two independent samples.
 See also example notebook for an overview
-`Poisson Rates <examples/notebooks/generated/stats_poisson.html>`__
+`Poisson Rates <examples/notebooks/generated/stats_poisson.ipynb>`_
 
 Status: experimental, API might change, added in 0.12, refactored and enhanced
 in 0.14
@@ -738,7 +738,7 @@ Functions for basic meta-analysis of a collection of sample statistics.
 
 Examples can be found in the notebook
 
- * `Meta-Analysis <examples/notebooks/generated/metaanalysis1.html>`__
+ * `Meta-Analysis <examples/notebooks/generated/metaanalysis1.ipynb>`_
 
 Status: experimental, API might change, added in 0.12
 
diff --git a/docs/source/treatment.rst b/docs/source/treatment.rst
@@ -22,7 +22,7 @@ statistics, average treatment effect ATE, potential outcome means POM, and
 for some methods optionally average treatment effect on the treated ATT.
 
 See also overview notebook in
-`Treatment Effect <examples/notebooks/generated/treatment_effect.html>`__
+`Treatment Effect <examples/notebooks/generated/treatment_effect.ipynb>`_
 
 .. module:: statsmodels.treatment
 .. currentmodule:: statsmodels.treatment
diff --git a/docs/source/tsa.rst b/docs/source/tsa.rst
@@ -116,7 +116,7 @@ AR-X and related models can also be fitted with the `arima.ARIMA` class and the
 `SARIMAX` class (using full MLE via the Kalman Filter).
 
 See the notebook `Autoregressions
-<../examples/notebooks/generated/autoregressions.html>`__ for an overview.
+<examples/notebooks/generated/autoregressions.ipynb>`_ for an overview.
 
 
 Autoregressive Moving-Average Processes (ARMA) and Kalman Filter
@@ -140,8 +140,8 @@ number of inherited features from the :ref:`state space <statespace>` models
 impulse responses, etc.).
 
 See the notebooks `ARMA: Sunspots Data
-<../examples/notebooks/generated/tsa_arma_0.html>`__ and
-`ARMA: Artificial Data <../examples/notebooks/generated/tsa_arma_1.html>`__
+<examples/notebooks/generated/tsa_arma_0.ipynb>`_ and
+`ARMA: Artificial Data <examples/notebooks/generated/tsa_arma_1.ipynb>`_
 for an overview.
 
 
@@ -191,7 +191,7 @@ and impulse responses, etc.).
    statespace.exponential_smoothing.ExponentialSmoothingResults
 
 See the notebook `Exponential Smoothing
-<../examples/notebooks/generated/exponential_smoothing.html>`__
+<examples/notebooks/generated/exponential_smoothing.ipynb>`_
 for an overview.
 
 ARMA Process
@@ -255,7 +255,7 @@ AR-X and related models can also be fitted with
 the Kalman Filter).
 
 See the notebook `Autoregressive Distributed Lag Models
-<../examples/notebooks/generated/autoregressive_distributed_lag.html>`__
+<examples/notebooks/generated/autoregressive_distributed_lag.ipynb>`_
 for an overview.
 
 Error Correction Models (ECM)
@@ -300,9 +300,9 @@ Regime switching models
    MarkovAutoregression
 
 See the notebooks `Markov switching dynamic regression
-<../examples/notebooks/generated/markov_regression.html>`__ and
+<examples/notebooks/generated/markov_regression.ipynb>`_ and
 `Markov switching autoregression
-<../examples/notebooks/generated/markov_autoregression.html>`__
+<examples/notebooks/generated/markov_autoregression.ipynb>`_
 for an overview.
 
 Time Series Filters
@@ -347,7 +347,7 @@ Time Series Filters
    DecomposeResult
    
 See the notebook `Time Series Filters
-<../examples/notebooks/generated/tsa_filters.html>`__ for an overview.
+<examples/notebooks/generated/tsa_filters.ipynb>`_ for an overview.
 
 TSA Tools
 """""""""
@@ -412,7 +412,7 @@ Users who wish to write custom deterministic terms must use subclass
 :class:`~statsmodels.tsa.deterministic.DeterministicTerm`.
    
 See the notebook `Deterministic Terms in Time Series Models
-<../examples/notebooks/generated/deterministics.html>`__ for an overview.
+<examples/notebooks/generated/deterministics.ipynb>`_ for an overview.
 
 Forecasting Models
 """"""""""""""""""
@@ -460,7 +460,7 @@ a random-walk model.
    STLForecastResults
 
 See the notebook `Seasonal Decomposition
-<../examples/notebooks/generated/stl_decomposition.html>`__ for an overview.
+<examples/notebooks/generated/stl_decomposition.ipynb>`_ for an overview.
 
 Prediction Results
 """"""""""""""""""
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,6 +1,6 @@
 # build
 cython>=0.29.28,<3.0.0
-setuptools_scm[toml]~=7.0.0
+setuptools_scm[toml]~=7.0
 oldest-supported-numpy>=2022.4.18
 
 # run
@@ -11,7 +11,7 @@ joblib
 # cvxopt; os_name != "win32"
 
 # test
-pytest~=7.0.1
+pytest>=7.3.0
 pytest-randomly
 pytest-xdist
 
