BazerUtils.jl

commit 6583820078112e7fd57fd1001f80533225cf793d
parent 692157b3fb0386125309b08dc89030fa0c9bd73c
Author: Erik Loualiche <eloualic@umn.edu>
Date:   Thu,  5 Jun 2025 15:20:54 -0500

doc fix

Diffstat:
M
.gitignore
 | 
2
+-
M
docs/make.jl
 | 
45
++++++++++++++++++++++++++-------------------
M
src/CustomLogger.jl
 | 
4
+---

3 files changed, 28 insertions(+), 23 deletions(-)
diff --git a/.gitignore b/.gitignore
@@ -3,7 +3,7 @@
 # STANDARD JULIA IGNORE
 /Manifest.toml
 /Manifest*.toml
-docs/build/
+docs/
 docs/node_modules
 .DS_Store
 docs/.DS_Store
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,10 +1,9 @@
 #!/usr/bin/env julia
 
 
-# push!(LOAD_PATH, "../src/")
-# import Pkg; Pkg.develop("../src")
-# locally : julia --color=yes --project make.jl
-
+push!(LOAD_PATH, "../src/")
+# Pkg.develop("../") to make sure its the correct version of package installed
+# julia --project -e 'using Pkg; Pkg.instantiate(); include("make.jl")'
 
 # --------------------------------------------------------------------------------------------------
 # --
@@ -13,40 +12,48 @@ using Documenter
 using DocumenterVitepress
 
 # --
+DocMeta.setdocmeta!(BazerUtils, :DocTestSetup, :(using BazerUtils);
+    recursive=true)
+
+# --
 makedocs(
-    format = Documenter.HTML(
-        size_threshold = 512_000,          # KiB — raise above your largest file
-        size_threshold_warn = 256_000,     # optional
-        example_size_threshold = 200_000,  # bytes — for large @example blocks
+    # format = Documenter.HTML(),
+    format = MarkdownVitepress(
+        repo = "https://github.com/louloulibs/BazerUtils.jl",
+        devurl = "dev",
+        devbranch = "build",
+        deploy_url = "louloulibs.github.io/BazerUtils.jl",
+        description = "BazerUtils.jl",
     ),
-    # format = DocumenterVitepress.MarkdownVitepress(
-    #     repo = "https://github.com/eloualiche/BazerUtils.jl",
-    # ),
-    repo = Remotes.GitHub("eloualiche", "BazerUtils.jl"),
     sitename = "BazerUtils.jl",
     modules  = [BazerUtils],
     authors = "Erik Loualiche",
+    repo = Remotes.GitHub("louloulibs", "BazerUtils.jl"),
     pages=[
         "Home" => "index.md",
         "Manual" => [
             "man/logger_guide.md",
             "man/read_jsonl.md",
         ],
-        # "Demos" => [
-        # ],
         "Library" => [
             "lib/public.md",
             "lib/internals.md"
         ]
-    ]
+    ],
 )
 
 
+deploydocs(
+    repo="github.com/louloulibs/BazerUtils.jl",
+    target = "build",
+)
+
 deploydocs(;
-    repo = "github.com/eloualiche/BazerUtils.jl",
-    target = "build", # this is where Vitepress stores its output
-    devbranch = "main",
+    repo="github.com/louloulibs/BazerUtils.jl",
+    target = "build",
     branch = "gh-pages",
-    push_preview = true,
+    devbranch = "main",  # or "master"
 )
+
+
 # --------------------------------------------------------------------------------------------------
diff --git a/src/CustomLogger.jl b/src/CustomLogger.jl
@@ -456,9 +456,7 @@ const syslog_severity_map = Dict( # look at get color to get something nicer tha
 # ----- where are the binaries!
 const julia_bin = Base.julia_cmd().exec[1]
 
-"""
-    format_syslog
-"""
+
 function format_syslog(log_record::NamedTuple)::AbstractString
 
     timestamp = Dates.format(now(), ISODateTimeFormat)