Merge pull request MilesCranmer#491 from MilesCranmer/docs-fixes

WIP: Fix some issues with docs

Author: MilesCranmer

docs/src/.vitepress/theme/index.ts

@@ -28,11 +28,23 @@ export const Theme: ThemeConfig = {
       'nav-screen-content-after': () => h(NolebaseEnhancedReadabilitiesScreenMenu),
     })
   },
-  enhanceApp({ app, router, siteData }) {
+  enhanceApp({ app, router }) {
     enhanceAppWithTabs(app);
     app.component('VersionPicker', VersionPicker);
     app.component('AuthorBadge', AuthorBadge)
     app.component('Authors', Authors)
+
+    // Auto-collapse MultitargetSRRegressor documentation
+    if (typeof window !== 'undefined') {
+      router.onAfterRouteChange = () => {
+        setTimeout(() => {
+          const details = document.querySelector('details:has(a[id*="MultitargetSRRegressor"])')
+          if (details?.hasAttribute('open')) {
+            details.removeAttribute('open')
+          }
+        }, 100)
+      }
+    }
   }
 }
 export default Theme

docs/src/.vitepress/theme/style.css

@@ -70,6 +70,10 @@ html.dark {
   background-clip: text;
 }
 
+.vp-doc .header-anchor {
+  -webkit-text-fill-color: var(--vp-c-brand-1) !important;
+}
+
 /* Subtle gold glow for code blocks */
 .vp-code-group .tabs .tab.active {
   color: var(--vp-c-brand-1);

docs/src/api.md

@@ -13,6 +13,12 @@ MultitargetSRRegressor
 equation_search
 ```
 
+## Template Expressions
+
+```@docs
+@template_spec
+```
+
 ## Options
 
 ```@docs

docs/src/examples.md

@@ -60,7 +60,7 @@ println(r.equations[r.best_idx])
 
 Here, we do the same thing, but with multiple expressions at once,
 each requiring a different feature. This means that we need to use
-`MultitargetSRRegressor` instead of `SRRegressor`:
+[`MultitargetSRRegressor`](@ref) instead of [`SRRegressor`](@ref):
 
 ```julia
 X = 2rand(1000, 5) .+ 0.1
@@ -85,7 +85,7 @@ end
 ## 4. Plotting an expression
 
 For now, let's consider the expressions for output 1 from the previous example:
-We can get a SymbolicUtils version with:
+We can get a SymbolicUtils version with [`node_to_symbolic`](@ref):
 
 ```julia
 using SymbolicUtils

docs/src/types.md

@@ -9,7 +9,7 @@ as follows.
 Node
 ```
 
-When you create an `Options` object, the operators
+When you create an [`Options`](@ref) object, the operators
 passed are also re-defined for `Node` types.
 This allows you use, e.g., `t=Node(; feature=1) * 3f0` to create a tree, so long as
 `*` was specified as a binary operator. This works automatically for
@@ -41,7 +41,7 @@ copy_node(tree::Node)
 
 ## Expressions
 
-Expressions are represented using the `Expression` type, which combines the raw `Node` type with an `OperatorEnum`.
+Expressions are represented using the [`Expression`](@ref) type, which combines the raw [`Node`](@ref) type with an `OperatorEnum`.
 
 ```@docs
 Expression

src/MLJInterface.jl

@@ -917,8 +917,12 @@ eval(
         replace(
             """
     Multi-target Symbolic Regression regressor (`MultitargetSRRegressor`)
-    conducts several searches for expressions that predict each target variable
-    from a set of input variables. All data is assumed to be `Continuous`.
+    searches for expressions that predict each target variable from a set
+    of input variables. This simply runs independent [`SRRegressor`](@ref)
+    searches for each target column in parallel - there is no joint modeling
+    of targets. All configuration options work identically to `SRRegressor`.
+
+    All data is assumed to be `Continuous`.
     The search is performed using an evolutionary algorithm.
     This algorithm is described in the paper
     https://arxiv.org/abs/2305.01582.