fixup incorrect table of content entries (thanks pre-commit hook)

Author: MarcoGorelli

notebooks/table_of_contents_examples.js

@@ -14,7 +14,7 @@ Gallery.contents = {
     "generalized_linear_models/GLM-logistic": "(Generalized) Linear and Hierarchical Linear Models",
     "generalized_linear_models/GLM-hierarchical-binominal-model": "(Generalized) Linear and Hierarchical Linear Models",
     "generalized_linear_models/GLM-hierarchical": "(Generalized) Linear and Hierarchical Linear Models",
-    "case/studies/hierarchical_partial_pooling": "(Generalized) Linear and Hierarchical Linear Models",
+    "case_studies/hierarchical_partial_pooling": "(Generalized) Linear and Hierarchical Linear Models",
     "generalized_linear_models/GLM-model-selection": "(Generalized) Linear and Hierarchical Linear Models",
     "generalized_linear_models/GLM-negative-binomial-regression": "(Generalized) Linear and Hierarchical Linear Models",
     "generalized_linear_models/GLM-poisson-regression": "(Generalized) Linear and Hierarchical Linear Models",
@@ -39,7 +39,7 @@ Gallery.contents = {
     "mixture_models/dp_mix": "Mixture Models",
     "variational_inference/gaussian-mixture-model-advi": "Mixture Models",
     "mixture_models/gaussian_mixture_model": "Mixture Models",
-    "marginalized_gaussian_mixture_model": "Mixture Models",
+    "mixture_models/marginalized_gaussian_mixture_model": "Mixture Models",
     "samplers/SMC2_gaussians": "Simulation-based Inference",
     "samplers/SMC-ABC_Lotka-Volterra_example": "Simulation-based Inference",
     "survival_analysis/bayes_param_survival_pymc3": "Survival Analysis",
@@ -48,7 +48,7 @@ Gallery.contents = {
     "survival_analysis/weibull_aft": "Survival Analysis",
     "survival_analysis/cox_model": "Survival Analysis",
     "time_series/MvGaussianRandomWalk_demo": "Time Series",
-    "time_series/R": "Time Series",
+    "time_series/AR": "Time Series",
     "time_series/Euler-Maruyama_and_SDEs": "Time Series",
     "variational_inference/bayesian_neural_network_advi": "Variational Inference",
     "variational_inference/convolutional_vae_keras_advi": "Variational Inference",

scripts/check_toc_is_complete.py

@@ -0,0 +1,25 @@
+"""
+Check that given Jupyter notebooks all appear in the table of contents.
+
+This is intended to be used as a pre-commit hook, see `.pre-commit-config.yaml`.
+You can run it manually with `pre-commit run check-toc --all`.
+"""
+
+import argparse
+import ast
+
+from pathlib import Path
+
+if __name__ == "__main__":
+    toc_examples = (Path("notebooks") / "table_of_contents_examples.js").read_text()
+    toc_tutorials = (Path("notebooks") / "table_of_contents_tutorials.js").read_text()
+    toc_keys = {
+        **ast.literal_eval(toc_examples[toc_examples.find("{") :]),
+        **ast.literal_eval(toc_tutorials[toc_tutorials.find("{") :]),
+    }.keys()
+    parser = argparse.ArgumentParser()
+    parser.add_argument("paths", nargs="*", type=Path)
+    args = parser.parse_args()
+    for path in args.paths:
+        notebook_name = path.relative_to('notebooks').with_suffix('').as_posix()
+        assert notebook_name in toc_keys, f"Notebook '{notebook_name}' not added to table of contents!"