fix: docs (#102)

* fix: docs

* compat: tests

* ci: CompatHelper in multiple subdirs

* fix: authors

* docs: linkcheck

* fix: docs again

* ci: compat drop on docs and test

suggested by @rikhuijzer

Author: storopoli

.github/workflows/CompatHelper.yml

@@ -6,11 +6,18 @@ on:
 jobs:
   CompatHelper:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        subdir: [
+          {dir: "", compat: "KeepEntry()"},
+          {dir: "docs", compat: "DropEntry()"},
+          {dir: "test", compat: "DropEntry()"},
+          ]
     steps:
       - name: Pkg.add("CompatHelper")
         run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
       - name: CompatHelper.main()
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
-        run: julia -e 'using CompatHelper; CompatHelper.main()'
+        run: julia -e 'using CompatHelper; CompatHelper.main(; subdirs=["${{ matrix.subdir.dir }}"], entry_type=${{ matrix.subdir.compat }})'

docs/Project.toml

@@ -9,9 +9,9 @@ PlutoStaticHTML = "359b1769-a58e-495b-9770-312e911026ad"
 TuringGLM = "0004c1f4-53c5-4d43-a221-a1dac6cf6b74"
 
 [compat]
-CSV = "0.9, 1"
-CairoMakie = "0.7"
+CSV = "0.10, 1"
+CairoMakie = "0.11"
 CategoricalArrays = "0.10"
 DataFrames = "1"
-Documenter = "0.27"
-PlutoStaticHTML = "5"
+Documenter = "1"
+PlutoStaticHTML = "6"

docs/make.jl

@@ -24,16 +24,18 @@ DocMeta.setdocmeta!(TuringGLM, :DocTestSetup, :(using TuringGLM); recursive=true
 makedocs(;
     modules=[TuringGLM],
     authors="Jose Storopoli <[email protected]>, Rik Huijzer <[email protected]>, and contributors",
-    repo="https://github.com/TuringLang/TuringGLM.jl/blob/{commit}{path}#{line}",
     sitename="TuringGLM.jl",
     format=Documenter.HTML(;
         assets=["assets/favicon.ico"],
         canonical="https://TuringLang.github.io/TuringGLM.jl",
         # Using MathJax3 since Pluto uses that engine too.
         mathengine=Documenter.MathJax3(),
         prettyurls=get(ENV, "CI", "false") == "true",
+        size_threshold=600 * 2^10, # 600 KiB
+        size_threshold_warn=200 * 2^10, # 200 KiB
     ),
     pages=["Home" => "index.md", "Tutorials" => T, "API reference" => "api.md"],
+    linkcheck=true,
 )
 
 deploydocs(; repo="github.com/TuringLang/TuringGLM.jl", devbranch="main")

docs/src/index.md

@@ -11,7 +11,7 @@ We recommend always using it with the latest stable Julia release.
 
 TuringGLM makes easy to specify Bayesian **G**eneralized **L**inear **M**odels using the formula syntax and returns an instantiated [Turing](https://github.com/TuringLang/Turing.jl) model.
 
-Heavily inspired by [brms](https://github.com/paul-buerkner/brms/) (uses RStan or CmdStanR) and [bambi](https://github.com/bambinos/bambi) (uses PyMC3).
+Heavily inspired by [brms](https://github.com/paul-buerkner/brms/) (uses RStan or CmdStanR) and [bambi](https://github.com/bambinos/bambi/) (uses PyMC3).
 
 ### `@formula`
 

test/Project.toml

@@ -12,7 +12,7 @@ Tracker = "9f7883ad-71c0-57eb-9f7f-b5c9e6d3789c"
 Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
 
 [compat]
-CSV = "0.9, 1"
+CSV = "0.10, 1"
 CategoricalArrays = "0.10"
 DataFrames = "1"
 TimerOutputs = "0.5"