simplify pre-commit and jupytext settings (#483)

* modify pre-commit and jupytext * ignore myst files when building docs
pymc-devs · Dec 27, 2022 · dd0b2b8 · dd0b2b8
1 parent fafe18f
commit dd0b2b8
Show file tree

Hide file tree

Showing 106 changed files with 23 additions and 138 deletions.
diff --git a/.jupytext.toml b/.jupytext.toml
@@ -1,5 +1,2 @@
-notebook_metadata_filter = "substitutions"
-
-[formats]
-"examples/" = "ipynb"
-"myst_nbs/" = ".myst.md:myst"
+notebook_metadata_filter = "substitutions,-jupytext.text_representation.jupytext_version"
+formats = ["ipynb", ".myst.md:myst"]
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,10 +1,4 @@
 repos:
-- repo: https://github.com/mwouts/jupytext
-  rev: v1.13.7
-  hooks:
-  - id: jupytext
-    files: ^examples/.+\.ipynb$
-    args: ["--sync"]
 - repo: https://github.com/psf/black
   rev: 22.3.0
   hooks:
@@ -63,7 +57,7 @@ repos:
       name: Check no references that should be sphinx cross-references are urls
       description: >-
         'A quick check to prevent urls pointing to pymc docs or other sphinx built docs like arviz, numpy, scipy...'
-      files: ^examples/
+      files: ^examples/.+\.ipynb$
       exclude: >
           (?x)(index.md|
                404.md|
@@ -108,10 +102,4 @@ repos:
   hooks:
   - id: jupytext
     files: ^examples/.+\.ipynb$
-    args: ["--sync"]
-- repo: https://github.com/codespell-project/codespell
-  rev: v2.1.0
-  hooks:
-  - id: codespell
-    files: myst_nbs/
-    args: ["--write-changes", "--ignore-words-list", "hist,fpr,fro,lik", "--uri-ignore-words-list", "*"]
+    args: [--from, ipynb, --to, ".myst.md:myst"]
diff --git a/...bs/case_studies/BART_introduction.myst.md → ...es/case_studies/BART_introduction.myst.md b/...bs/case_studies/BART_introduction.myst.md → ...es/case_studies/BART_introduction.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/myst_nbs/case_studies/BEST.myst.md → examples/case_studies/BEST.myst.md b/myst_nbs/case_studies/BEST.myst.md → examples/case_studies/BEST.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: bayes_toolbox
   language: python

diff --git a/myst_nbs/case_studies/GEV.myst.md → examples/case_studies/GEV.myst.md b/myst_nbs/case_studies/GEV.myst.md → examples/case_studies/GEV.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: pymc4-dev
   language: python

diff --git a/myst_nbs/case_studies/LKJ.myst.md → examples/case_studies/LKJ.myst.md b/myst_nbs/case_studies/LKJ.myst.md → examples/case_studies/LKJ.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/.../bayesian_ab_testing_introduction.myst.md → .../bayesian_ab_testing_introduction.myst.md b/.../bayesian_ab_testing_introduction.myst.md → .../bayesian_ab_testing_introduction.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3.8.10 ('pymc-examples-ipRlw-UN')
   language: python

diff --git a/myst_nbs/case_studies/binning.myst.md → examples/case_studies/binning.myst.md b/myst_nbs/case_studies/binning.myst.md → examples/case_studies/binning.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python [conda env:pymc_env]
   language: python

diff --git a/...dies/blackbox_external_likelihood.myst.md → ...dies/blackbox_external_likelihood.myst.md b/...dies/blackbox_external_likelihood.myst.md → ...dies/blackbox_external_likelihood.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
@@ -573,7 +572,7 @@ import warnings
 
 warnings.simplefilter(
     action="ignore", category=FutureWarning
-)  # suppress emcee autocorr FutureWarning
+)  # suppress emcee autocorr FutureWarning
 
 matplotlib.rcParams["font.size"] = 18
 

diff --git a/...lackbox_external_likelihood_numpy.myst.md → ...lackbox_external_likelihood_numpy.myst.md b/...lackbox_external_likelihood_numpy.myst.md → ...lackbox_external_likelihood_numpy.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/.../conditional-autoregressive-model.myst.md → .../conditional-autoregressive-model.myst.md b/.../conditional-autoregressive-model.myst.md → .../conditional-autoregressive-model.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
@@ -644,7 +643,7 @@ class Sparse_CAR(distribution.Continuous):
         self.W = theano.sparse.as_sparse_variable(w_sparse)
         self.D = tt.as_tensor_variable(D)
 
-        # Precision Matrix (inverse of Covariance matrix)
+        # Precision Matrix (inverse of Covariance matrix)
         # d_sparse = scipy.sparse.csr_matrix(np.diag(D))
         # self.D = theano.sparse.as_sparse_variable(d_sparse)
         # self.Phi = self.tau * (self.D - self.alpha*self.W)

diff --git a/..._nbs/case_studies/factor_analysis.myst.md → ...ples/case_studies/factor_analysis.myst.md b/..._nbs/case_studies/factor_analysis.myst.md → ...ples/case_studies/factor_analysis.myst.md
@@ -5,7 +5,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/...dies/hierarchical_partial_pooling.myst.md → ...dies/hierarchical_partial_pooling.myst.md b/...dies/hierarchical_partial_pooling.myst.md → ...dies/hierarchical_partial_pooling.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3.10.5 ('pymc-dev')
   language: python

diff --git a/...bs/case_studies/item_response_nba.myst.md → ...es/case_studies/item_response_nba.myst.md b/...bs/case_studies/item_response_nba.myst.md → ...es/case_studies/item_response_nba.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/...s/case_studies/mediation_analysis.myst.md → ...s/case_studies/mediation_analysis.myst.md b/...s/case_studies/mediation_analysis.myst.md → ...s/case_studies/mediation_analysis.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/.../case_studies/moderation_analysis.myst.md → .../case_studies/moderation_analysis.myst.md b/.../case_studies/moderation_analysis.myst.md → .../case_studies/moderation_analysis.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: pymc-dev-py39
   language: python

diff --git a/.../case_studies/multilevel_modeling.myst.md → .../case_studies/multilevel_modeling.myst.md b/.../case_studies/multilevel_modeling.myst.md → .../case_studies/multilevel_modeling.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/...robabilistic_matrix_factorization.myst.md → ...robabilistic_matrix_factorization.myst.md b/...robabilistic_matrix_factorization.myst.md → ...robabilistic_matrix_factorization.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/...nbs/case_studies/putting_workflow.myst.md → ...les/case_studies/putting_workflow.myst.md b/...nbs/case_studies/putting_workflow.myst.md → ...les/case_studies/putting_workflow.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3.10.6 ('pymc_env')
   language: python

diff --git a/...se_studies/reinforcement_learning.myst.md → ...se_studies/reinforcement_learning.myst.md b/...se_studies/reinforcement_learning.myst.md → ...se_studies/reinforcement_learning.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/..._nbs/case_studies/rugby_analytics.myst.md → ...ples/case_studies/rugby_analytics.myst.md b/..._nbs/case_studies/rugby_analytics.myst.md → ...ples/case_studies/rugby_analytics.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/myst_nbs/case_studies/spline.myst.md → examples/case_studies/spline.myst.md b/myst_nbs/case_studies/spline.myst.md → examples/case_studies/spline.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/...ase_studies/stochastic_volatility.myst.md → ...ase_studies/stochastic_volatility.myst.md b/...ase_studies/stochastic_volatility.myst.md → ...ase_studies/stochastic_volatility.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: pymc_env
   language: python

diff --git a/...ase_studies/wrapping_jax_function.myst.md → ...ase_studies/wrapping_jax_function.myst.md b/...ase_studies/wrapping_jax_function.myst.md → ...ase_studies/wrapping_jax_function.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: pymc-examples
   language: python

diff --git a/...ference/difference_in_differences.myst.md → ...ference/difference_in_differences.myst.md b/...ference/difference_in_differences.myst.md → ...ference/difference_in_differences.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: pymc_env
   language: python

diff --git a/...bs/causal_inference/excess_deaths.myst.md → ...es/causal_inference/excess_deaths.myst.md b/...bs/causal_inference/excess_deaths.myst.md → ...es/causal_inference/excess_deaths.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: pymc_env
   language: python

diff --git a/...inference/interrupted_time_series.myst.md → ...inference/interrupted_time_series.myst.md b/...inference/interrupted_time_series.myst.md → ...inference/interrupted_time_series.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: pymc_env
   language: python

diff --git a/...nference/regression_discontinuity.myst.md → ...nference/regression_discontinuity.myst.md b/...nference/regression_discontinuity.myst.md → ...nference/regression_discontinuity.myst.md
@@ -5,7 +5,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: pymc-dev-py39
   language: python

diff --git a/examples/conf.py b/examples/conf.py
@@ -42,6 +42,7 @@
     "**/.ipynb_checkpoints/*",
     "extra_installs.md",
     "page_footer.md",
+    "**/*.myst.md",
 ]
 
 
@@ -174,7 +175,7 @@ def setup(app: Sphinx):
 citation_code = f"""
 ```bibtex
 @incollection{{citekey,
-  author    = "<notebook authors, see above>"
+  author    = "<notebook authors, see above>",
   title     = "<notebook title>",
   editor    = "PyMC Team",
   booktitle = "PyMC examples",
@@ -190,7 +191,7 @@ def setup(app: Sphinx):
     "extra_install_notes": "",
     "citation_code": citation_code,
 }
-jupyter_execute_notebooks = "off"
+nb_execution_mode = "off"
 
 rediraffe_redirects = {
     "index.md": "gallery.md",
@@ -227,13 +228,13 @@ def setup(app: Sphinx):
 intersphinx_mapping = {
     "aesara": ("https://aesara.readthedocs.io/en/latest/", None),
     "arviz": ("https://python.arviz.org/en/latest/", None),
-    "bambi": ("https://bambinos.github.io/bambi/main", None),
+    "bambi": ("https://bambinos.github.io/bambi", None),
     "einstats": ("https://einstats.python.arviz.org/en/latest/", None),
     "mpl": ("https://matplotlib.org/", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
     "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
     "pymc": ("https://www.pymc.io/projects/docs/en/stable/", None),
     "pmx": ("https://www.pymc.io/projects/experimental/en/latest/", None),
     "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
-    "xarray": ("http://docs.xarray.dev/en/stable/", None),
+    "xarray": ("https://docs.xarray.dev/en/stable/", None),
 }
diff --git a/...ostics_and_criticism/Bayes_factor.myst.md → ...ostics_and_criticism/Bayes_factor.myst.md b/...ostics_and_criticism/Bayes_factor.myst.md → ...ostics_and_criticism/Bayes_factor.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3
   language: python

diff --git a/...biased_Inference_with_Divergences.myst.md → ...biased_Inference_with_Divergences.myst.md b/...biased_Inference_with_Divergences.myst.md → ...biased_Inference_with_Divergences.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/...ics_and_criticism/model_averaging.myst.md → ...ics_and_criticism/model_averaging.myst.md b/...ics_and_criticism/model_averaging.myst.md → ...ics_and_criticism/model_averaging.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/...stics_and_criticism/sampler-stats.myst.md → ...stics_and_criticism/sampler-stats.myst.md b/...stics_and_criticism/sampler-stats.myst.md → ...stics_and_criticism/sampler-stats.myst.md
@@ -5,7 +5,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/...bs/gaussian_processes/GP-Circular.myst.md → ...es/gaussian_processes/GP-Circular.myst.md b/...bs/gaussian_processes/GP-Circular.myst.md → ...es/gaussian_processes/GP-Circular.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: pymc3
   language: python

diff --git a/...sian_processes/GP-Heteroskedastic.myst.md → ...sian_processes/GP-Heteroskedastic.myst.md b/...sian_processes/GP-Heteroskedastic.myst.md → ...sian_processes/GP-Heteroskedastic.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python [conda env:pymc3]
   language: python

diff --git a/myst_nbs/gaussian_processes/GP-Kron.myst.md → examples/gaussian_processes/GP-Kron.myst.md b/myst_nbs/gaussian_processes/GP-Kron.myst.md → examples/gaussian_processes/GP-Kron.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3 (ipykernel)
   language: python

diff --git a/..._nbs/gaussian_processes/GP-Latent.myst.md → ...ples/gaussian_processes/GP-Latent.myst.md b/..._nbs/gaussian_processes/GP-Latent.myst.md → ...ples/gaussian_processes/GP-Latent.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: pymc-dev
   language: python

diff --git a/...bs/gaussian_processes/GP-Marginal.myst.md → ...es/gaussian_processes/GP-Marginal.myst.md b/...bs/gaussian_processes/GP-Marginal.myst.md → ...es/gaussian_processes/GP-Marginal.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3
   language: python

diff --git a/...bs/gaussian_processes/GP-MaunaLoa.myst.md → ...es/gaussian_processes/GP-MaunaLoa.myst.md b/...bs/gaussian_processes/GP-MaunaLoa.myst.md → ...es/gaussian_processes/GP-MaunaLoa.myst.md
@@ -4,7 +4,6 @@ jupytext:
     extension: .md
     format_name: myst
     format_version: 0.13
-    jupytext_version: 1.13.7
 kernelspec:
   display_name: Python 3
   language: python