SmoothForge · danielward27 · Sep 8, 2025 · Sep 8, 2025 · Sep 8, 2025
diff --git a/docs/api/families.md b/docs/api/families.md
@@ -2,123 +2,46 @@
 
 Families define the distribution and link functions for GAM models. Each family corresponds to a statistical distribution and supports specific link functions.
 
-!!! warning
-
-    The families are not well tested, and mgcv has many families with inconsistent structures of inputs and outputs. Some families, although provided here, may not
-    currently work (but will be supported in due course).
-
+## Continuous response
 ::: pymgcv.families.Gaussian
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.Binomial
-    options:
-      members:
-        - "__init__"
 ::: pymgcv.families.Gamma
-    options:
-      members:
-        - "__init__"
 ::: pymgcv.families.InverseGaussian
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.Poisson
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.Quasi
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.QuasiBinomial
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.QuasiPoisson
-    options:
-      members:
-        - "__init__"
 ::: pymgcv.families.Tweedie
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.NegBin
-    optionsTweedie:
-      members:
-        - "__init__"
-::: pymgcv.families.Betar
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.CNorm
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.CLog
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.CPois
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.OCat
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.Scat
-    options:
-      members:
-        - "__init__"
 ::: pymgcv.families.Tw
-    options:
-      members:
-        - "__init__"
+::: pymgcv.families.Scat
+::: pymgcv.families.MVN
+
+## Count and proportions
+::: pymgcv.families.Poisson
+::: pymgcv.families.NegativeBinomial
 ::: pymgcv.families.ZIP
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.CoxPH
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.GammaLS
-    Options:
-      members:
-        - "__init__"
+::: pymgcv.families.Betar
+
+## Categorical and ordinal
+::: pymgcv.families.Binomial
+::: pymgcv.families.OCat
+::: pymgcv.families.Multinom
+
+## Location-scale
 ::: pymgcv.families.GauLSS
-    options:
-      members:
-        - "__init__"
+::: pymgcv.families.GammaLS
 ::: pymgcv.families.GevLSS
-    Options:
-      members:
-        - "__init__"
 ::: pymgcv.families.GumbLS
-    Options:
-      members:
-        - "__init__"
-::: pymgcv.families.Multinom
-    options:
-      members:
-        - "__init__"
-::: pymgcv.families.MVN
-    options:
-      members:
-        - "__init__"
 ::: pymgcv.families.Shash
-    options:
-      members:
-        - "__init__"
+
+## Quasi-likelihood
+::: pymgcv.families.Quasi
+::: pymgcv.families.QuasiBinomial
+::: pymgcv.families.QuasiPoisson
+
+## Not yet implemented
 ::: pymgcv.families.TwLSS
-    Options:
-      members:
-        - "__init__"
 ::: pymgcv.families.ZipLSS
-    Options:
-      members:
-        - "__init__"
+::: pymgcv.families.CNorm
+::: pymgcv.families.CLog
+::: pymgcv.families.CPois
+::: pymgcv.families.CoxPH
 
+## Base classes
 ::: pymgcv.families.AbstractFamily
 ::: pymgcv.families.SupportsCDF
diff --git a/docs/api/gam.md b/docs/api/gam.md
@@ -1,15 +1,6 @@
 # GAMs
 GAM model types from ``pymgcv.gam``.
 
-::: pymgcv.gam.AbstractGAM
-    options:
-        heading_level: 2
-        merge_init_into_class: false
-        filters:
-          - "!^_"
-          - "!fit"
-          - "!predict"
-          - "!partial_effects"
 
 ::: pymgcv.gam.GAM
     options:
@@ -21,6 +12,16 @@ GAM model types from ``pymgcv.gam``.
         heading_level: 2
         inherited_members: __init__
 
+::: pymgcv.gam.AbstractGAM
+    options:
+        heading_level: 2
+        merge_init_into_class: false
+        filters:
+          - "!^_"
+          - "!fit"
+          - "!predict"
+          - "!partial_effects"
+
 ::: pymgcv.gam.FitState
     options:
         heading_level: 2

diff --git a/docs/api/plot.md b/docs/api/plot.md
@@ -11,11 +11,13 @@ import pymgcv.plot as gplt
     * [`continuous_1d`][pymgcv.plot.continuous_1d]
     * [`continuous_2d`][pymgcv.plot.continuous_2d]
     * [`categorical`][pymgcv.plot.categorical]
+    * [`random_effect`][pymgcv.plot.random_effect]
 
 ::: pymgcv.plot.plot
 ::: pymgcv.plot.continuous_1d
 ::: pymgcv.plot.continuous_2d
 ::: pymgcv.plot.categorical
+::: pymgcv.plot.random_effect
 ::: pymgcv.plot.qq
 ::: pymgcv.plot.residuals_vs_linear_predictor
 ::: pymgcv.plot.hexbin_residuals
diff --git a/docs/examples/electricity_bam.ipynb b/docs/examples/electricity_bam.ipynb
diff --git a/docs/examples/gamlss.ipynb b/docs/examples/gamlss.ipynb
@@ -54,8 +54,10 @@
    "outputs": [],
    "source": [
     "gam = GAM(\n",
-    "    predictors={\"y\": S(\"x\")},\n",
-    "    family_predictors={\"scale\": S(\"x\")},\n",
+    "    {\n",
+    "        \"y\": S(\"x\"),\n",
+    "        \"scale\": S(\"x\"),\n",
+    "    },\n",
     "    family=GauLSS(),\n",
     ")\n",
     "\n",

diff --git a/docs/examples/linear_functional.ipynb b/docs/examples/linear_functional.ipynb
diff --git a/docs/examples/ozone.ipynb b/docs/examples/ozone.ipynb
diff --git a/docs/examples/smooth_by_categorical.ipynb b/docs/examples/smooth_by_categorical.ipynb
diff --git a/docs/examples/spatial_fish_eggs.ipynb b/docs/examples/spatial_fish_eggs.ipynb
diff --git a/docs/examples/supplement_vs_placebo.ipynb b/docs/examples/supplement_vs_placebo.ipynb
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -10,6 +10,7 @@ theme:
   icon:
     repo: fontawesome/brands/github
   logo: _static/favicon.svg
+  navigation_depth: 3
   favicon: "_static/favicon.svg"
 
 site_name: pymgcv
@@ -36,7 +37,7 @@ markdown_extensions:
       base_path: docs
   - admonition
   - toc:
-      toc_depth: 3
+      toc_depth: 2
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span