Skip to content

Commit 944ac67

Browse files
author
Kevin Sheppard
committed
DOC: Correct links to notebooks
closes statsmodels#8885
1 parent 2a3727c commit 944ac67

12 files changed

+34
-34
lines changed

docs/source/anova.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Examples
3030
3131
A more detailed example for `anova_lm` can be found here:
3232

33-
* `ANOVA <examples/notebooks/generated/interactions_anova.html>`__
33+
* `ANOVA <examples/notebooks/generated/interactions_anova.ipynb>`_
3434

3535
Module Reference
3636
----------------

docs/source/discretemod.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ Examples
3636
Detailed examples can be found here:
3737

3838

39-
* `Overview <examples/notebooks/generated/discrete_choice_overview.html>`__
40-
* `Examples <examples/notebooks/generated/discrete_choice_example.html>`__
39+
* `Overview <examples/notebooks/generated/discrete_choice_overview.ipynb>`_
40+
* `Examples <examples/notebooks/generated/discrete_choice_example.ipynb>`_
4141

4242
Technical Documentation
4343
-----------------------

docs/source/glm.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Examples
2828
2929
Detailed examples can be found here:
3030

31-
* `GLM <examples/notebooks/generated/glm.html>`__
32-
* `Formula <examples/notebooks/generated/glm_formula.html>`__
31+
* `GLM <examples/notebooks/generated/glm.ipynb>`_
32+
* `Formula <examples/notebooks/generated/glm_formula.ipynb>`_
3333

3434
Technical Documentation
3535
-----------------------

docs/source/large_data.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ A current limitation of this approach is that it generally does not support
2727
design matrix (known as `exog`) in statsmodels, is a little challenging.
2828

2929
A detailed example is available
30-
`here <examples/notebooks/generated/distributed_estimation.html>`_.
30+
`here <examples/notebooks/generated/distributed_estimation.ipynb>`_.
3131

3232
.. autosummary::
3333
:toctree: generated/

docs/source/mixed_linear.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Examples
9191
9292
Detailed examples can be found here
9393

94-
* `Mixed LM <examples/notebooks/generated/mixed_lm_example.html>`__
94+
* `Mixed LM <examples/notebooks/generated/mixed_lm_example.ipynb>`_
9595

9696
There are some notebook examples on the Wiki:
9797
`Wiki notebooks for MixedLM <https://github.com/statsmodels/statsmodels/wiki/Examples#linear-mixed-models>`_

docs/source/regression.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ Examples
3333
Detailed examples can be found here:
3434

3535

36-
* `OLS <examples/notebooks/generated/ols.html>`__
37-
* `WLS <examples/notebooks/generated/wls.html>`__
38-
* `GLS <examples/notebooks/generated/gls.html>`__
39-
* `Recursive LS <examples/notebooks/generated/recursive_ls.html>`__
40-
* `Rolling LS <examples/notebooks/generated/rolling_ls.html>`__
36+
* `OLS <examples/notebooks/generated/ols.ipynb>`_
37+
* `WLS <examples/notebooks/generated/wls.ipynb>`_
38+
* `GLS <examples/notebooks/generated/gls.ipynb>`_
39+
* `Recursive LS <examples/notebooks/generated/recursive_ls.ipynb>`_
40+
* `Rolling LS <examples/notebooks/generated/rolling_ls.ipynb>`_
4141

4242
Technical Documentation
4343
-----------------------

docs/source/rlm.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Examples
2727
2828
Detailed examples can be found here:
2929

30-
* `Robust Models 1 <examples/notebooks/generated/robust_models_0.html>`__
31-
* `Robust Models 2 <examples/notebooks/generated/robust_models_1.html>`__
30+
* `Robust Models 1 <examples/notebooks/generated/robust_models_0.ipynb>`_
31+
* `Robust Models 2 <examples/notebooks/generated/robust_models_1.ipynb>`_
3232

3333
Technical Documentation
3434
-----------------------

docs/source/statespace.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ arbitrary trend polynomials.
117117
sarimax.SARIMAXResults
118118

119119
For an example of the use of this model, see the
120-
`SARIMAX example notebook <examples/notebooks/generated/statespace_sarimax_stata.html>`__
120+
`SARIMAX example notebook <examples/notebooks/generated/statespace_sarimax_stata.ipynb>`_
121121
or the very brief code snippet below:
122122

123123

@@ -168,7 +168,7 @@ The `UnobservedComponents` class is another example of a statespace model.
168168
structural.UnobservedComponents
169169
structural.UnobservedComponentsResults
170170

171-
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:
171+
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:
172172

173173
.. code-block:: python
174174
@@ -215,7 +215,7 @@ The `VARMAX` class is an example of a multivariate statespace model.
215215
varmax.VARMAX
216216
varmax.VARMAXResults
217217

218-
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:
218+
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:
219219

220220
.. code-block:: python
221221
@@ -293,7 +293,7 @@ observed variables
293293
dynamic_factor.DynamicFactorResults
294294

295295
For an example of the use of the `DynamicFactor` model, see the
296-
`Dynamic Factor example notebook <examples/notebooks/generated/statespace_dfm_coincident.html>`__
296+
`Dynamic Factor example notebook <examples/notebooks/generated/statespace_dfm_coincident.ipynb>`_
297297

298298
Linear Exponential Smoothing Models
299299
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -382,7 +382,7 @@ likelihood fitting functionality for estimation and results output.
382382
mlemodel.PredictionResults
383383

384384
For a basic example demonstrating creating and estimating a custom state space
385-
model, see the `Local Linear Trend example notebook <examples/notebooks/generated/statespace_local_linear_trend.html>`__.
385+
model, see the `Local Linear Trend example notebook <examples/notebooks/generated/statespace_local_linear_trend.ipynb>`_.
386386
For a more sophisticated example, see the source code for the `SARIMAX` and
387387
`SARIMAXResults` classes, which are built by extending `MLEModel` and
388388
`MLEResults`.

docs/source/stats.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ Rates
465465
Statistical functions for rates. This currently includes hypothesis tests for
466466
two independent samples.
467467
See also example notebook for an overview
468-
`Poisson Rates <examples/notebooks/generated/stats_poisson.html>`__
468+
`Poisson Rates <examples/notebooks/generated/stats_poisson.ipynb>`_
469469

470470
Status: experimental, API might change, added in 0.12, refactored and enhanced
471471
in 0.14
@@ -738,7 +738,7 @@ Functions for basic meta-analysis of a collection of sample statistics.
738738

739739
Examples can be found in the notebook
740740

741-
* `Meta-Analysis <examples/notebooks/generated/metaanalysis1.html>`__
741+
* `Meta-Analysis <examples/notebooks/generated/metaanalysis1.ipynb>`_
742742

743743
Status: experimental, API might change, added in 0.12
744744

docs/source/treatment.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ statistics, average treatment effect ATE, potential outcome means POM, and
2222
for some methods optionally average treatment effect on the treated ATT.
2323

2424
See also overview notebook in
25-
`Treatment Effect <examples/notebooks/generated/treatment_effect.html>`__
25+
`Treatment Effect <examples/notebooks/generated/treatment_effect.ipynb>`_
2626

2727
.. module:: statsmodels.treatment
2828
.. currentmodule:: statsmodels.treatment

docs/source/tsa.rst

+10-10
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ AR-X and related models can also be fitted with the `arima.ARIMA` class and the
116116
`SARIMAX` class (using full MLE via the Kalman Filter).
117117

118118
See the notebook `Autoregressions
119-
<../examples/notebooks/generated/autoregressions.html>`__ for an overview.
119+
<examples/notebooks/generated/autoregressions.ipynb>`_ for an overview.
120120

121121

122122
Autoregressive Moving-Average Processes (ARMA) and Kalman Filter
@@ -140,8 +140,8 @@ number of inherited features from the :ref:`state space <statespace>` models
140140
impulse responses, etc.).
141141

142142
See the notebooks `ARMA: Sunspots Data
143-
<../examples/notebooks/generated/tsa_arma_0.html>`__ and
144-
`ARMA: Artificial Data <../examples/notebooks/generated/tsa_arma_1.html>`__
143+
<examples/notebooks/generated/tsa_arma_0.ipynb>`_ and
144+
`ARMA: Artificial Data <examples/notebooks/generated/tsa_arma_1.ipynb>`_
145145
for an overview.
146146

147147

@@ -191,7 +191,7 @@ and impulse responses, etc.).
191191
statespace.exponential_smoothing.ExponentialSmoothingResults
192192

193193
See the notebook `Exponential Smoothing
194-
<../examples/notebooks/generated/exponential_smoothing.html>`__
194+
<examples/notebooks/generated/exponential_smoothing.ipynb>`_
195195
for an overview.
196196

197197
ARMA Process
@@ -255,7 +255,7 @@ AR-X and related models can also be fitted with
255255
the Kalman Filter).
256256

257257
See the notebook `Autoregressive Distributed Lag Models
258-
<../examples/notebooks/generated/autoregressive_distributed_lag.html>`__
258+
<examples/notebooks/generated/autoregressive_distributed_lag.ipynb>`_
259259
for an overview.
260260

261261
Error Correction Models (ECM)
@@ -300,9 +300,9 @@ Regime switching models
300300
MarkovAutoregression
301301

302302
See the notebooks `Markov switching dynamic regression
303-
<../examples/notebooks/generated/markov_regression.html>`__ and
303+
<examples/notebooks/generated/markov_regression.ipynb>`_ and
304304
`Markov switching autoregression
305-
<../examples/notebooks/generated/markov_autoregression.html>`__
305+
<examples/notebooks/generated/markov_autoregression.ipynb>`_
306306
for an overview.
307307

308308
Time Series Filters
@@ -347,7 +347,7 @@ Time Series Filters
347347
DecomposeResult
348348

349349
See the notebook `Time Series Filters
350-
<../examples/notebooks/generated/tsa_filters.html>`__ for an overview.
350+
<examples/notebooks/generated/tsa_filters.ipynb>`_ for an overview.
351351

352352
TSA Tools
353353
"""""""""
@@ -412,7 +412,7 @@ Users who wish to write custom deterministic terms must use subclass
412412
:class:`~statsmodels.tsa.deterministic.DeterministicTerm`.
413413

414414
See the notebook `Deterministic Terms in Time Series Models
415-
<../examples/notebooks/generated/deterministics.html>`__ for an overview.
415+
<examples/notebooks/generated/deterministics.ipynb>`_ for an overview.
416416

417417
Forecasting Models
418418
""""""""""""""""""
@@ -460,7 +460,7 @@ a random-walk model.
460460
STLForecastResults
461461

462462
See the notebook `Seasonal Decomposition
463-
<../examples/notebooks/generated/stl_decomposition.html>`__ for an overview.
463+
<examples/notebooks/generated/stl_decomposition.ipynb>`_ for an overview.
464464

465465
Prediction Results
466466
""""""""""""""""""

requirements-dev.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# build
22
cython>=0.29.28,<3.0.0
3-
setuptools_scm[toml]~=7.0.0
3+
setuptools_scm[toml]~=7.0
44
oldest-supported-numpy>=2022.4.18
55

66
# run
@@ -11,7 +11,7 @@ joblib
1111
# cvxopt; os_name != "win32"
1212

1313
# test
14-
pytest~=7.0.1
14+
pytest>=7.3.0
1515
pytest-randomly
1616
pytest-xdist
1717

0 commit comments

Comments
 (0)