From 8c19a11cbe17e64c9e69248025a856fd171207de Mon Sep 17 00:00:00 2001 From: Ajinkya Kokandakar Date: Thu, 6 Mar 2025 00:33:51 -0600 Subject: [PATCH 1/4] added vitepress --- docs/Project.toml | 1 + docs/make.jl | 26 +++++++++++++++++--------- 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/docs/Project.toml b/docs/Project.toml index aa29942f9..f792ff713 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -4,6 +4,7 @@ DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0" DisplayAs = "0b91fe84-8a4c-11e9-3e1d-67c38462b6d6" Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365" FreqTables = "da1fdf0e-e0ff-5433-a45f-9bb5ff651cb1" Gadfly = "c91e804a-d5a3-530f-b6f0-dfbca275c004" MixedModels = "ff71e718-51f3-5ec2-a782-8ffcbfa3c316" diff --git a/docs/make.jl b/docs/make.jl index fb4f8e36f..0fd158bf1 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -2,23 +2,31 @@ using Documenter using MixedModels using StatsAPI using StatsBase +using DocumenterVitepress makedocs(; sitename="MixedModels", doctest=true, pages=[ "index.md", - "constructors.md", - "optimization.md", - "GaussHermite.md", - "prediction.md", - "bootstrap.md", - "rankdeficiency.md", - "mime.md", - "api.md", + "Articles" => [ + "constructors.md", + "optimization.md", + "GaussHermite.md", + "prediction.md", + "bootstrap.md", + "rankdeficiency.md", + "mime.md" + ], + "api.md" ], + format = DocumenterVitepress.MarkdownVitepress( + repo = "https://github.com/ajinkya-k/MixedModels.jl", + ), + clean = true ) deploydocs(; - repo="github.com/JuliaStats/MixedModels.jl.git", push_preview=true, devbranch="main" + target = "build", + repo="github.com/ajinkya-k/MixedModels.jl.git", push_preview=true, devbranch="ahk/doc-vite" ) From 6691c358dcb8ffedb7fa9e1fd8f95278d8ad5f4a Mon Sep 17 00:00:00 2001 From: Ajinkya Kokandakar Date: Mon, 10 Mar 2025 15:51:14 -0500 Subject: [PATCH 2/4] using documenter header id style --- docs/src/optimization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/optimization.md b/docs/src/optimization.md index f73a8e887..b1157123a 100644 --- a/docs/src/optimization.md +++ b/docs/src/optimization.md @@ -92,7 +92,7 @@ are sometimes called the *best linear unbiased predictors* or BLUPs of the rando Although BLUPs an appealing acronym, I don’t find the term particularly instructive (what is a “linear unbiased predictor” and in what sense are these the “best”?) and prefer the term “conditional modes”, because these are the values of $\bf b$ that maximize the density of the conditional distribution $\mathcal{B} | \mathcal{Y} = {\bf y}$. For a linear mixed model, where all the conditional and unconditional distributions are Gaussian, these values are also the *conditional means*. -## Internal structure of $\Lambda_\theta$ and $\bf Z$ +## [Internal structure of $\Lambda_\theta$ and $\bf Z$](@id internal-struct) In the types of `LinearMixedModel` available through the `MixedModels` package, groups of random effects and the corresponding columns of the model matrix, $\bf Z$, are associated with *random-effects terms* in the model formula. From 2a9cb31d26d61efbbe2dfcff2679f35e275368ec Mon Sep 17 00:00:00 2001 From: Ajinkya Kokandakar Date: Mon, 10 Mar 2025 16:57:14 -0500 Subject: [PATCH 3/4] more descriptive id for internal structure header --- docs/src/optimization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/optimization.md b/docs/src/optimization.md index b1157123a..225917758 100644 --- a/docs/src/optimization.md +++ b/docs/src/optimization.md @@ -92,7 +92,7 @@ are sometimes called the *best linear unbiased predictors* or BLUPs of the rando Although BLUPs an appealing acronym, I don’t find the term particularly instructive (what is a “linear unbiased predictor” and in what sense are these the “best”?) and prefer the term “conditional modes”, because these are the values of $\bf b$ that maximize the density of the conditional distribution $\mathcal{B} | \mathcal{Y} = {\bf y}$. For a linear mixed model, where all the conditional and unconditional distributions are Gaussian, these values are also the *conditional means*. -## [Internal structure of $\Lambda_\theta$ and $\bf Z$](@id internal-struct) +## [Internal structure of $\Lambda_\theta$ and $\bf Z$](@id Internal-structure-of-random-effects-coefficients-and-model-matrix) In the types of `LinearMixedModel` available through the `MixedModels` package, groups of random effects and the corresponding columns of the model matrix, $\bf Z$, are associated with *random-effects terms* in the model formula. From 3f6694cfe2470203ad834f6604317ab0c58c1c28 Mon Sep 17 00:00:00 2001 From: Ajinkya Kokandakar Date: Tue, 25 Mar 2025 09:04:05 -0500 Subject: [PATCH 4/4] changed urls to juliatstats versions --- docs/make.jl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 0fd158bf1..508852378 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -21,12 +21,12 @@ makedocs(; "api.md" ], format = DocumenterVitepress.MarkdownVitepress( - repo = "https://github.com/ajinkya-k/MixedModels.jl", + repo = "https://github.com/JuliaStats/MixedModels.jl", ), clean = true ) deploydocs(; target = "build", - repo="github.com/ajinkya-k/MixedModels.jl.git", push_preview=true, devbranch="ahk/doc-vite" + repo="github.com/JuliaStats/MixedModels.jl.git", push_preview=true, devbranch="ahk/doc-vite" )