Merge branch 'MilesCranmer:abstract-popmember' into abstract-popmember

Author: atharvas

.github/workflows/Documentation.yml

@@ -48,6 +48,8 @@ jobs:
         run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
       - name: "Install Node.js dependencies"
         run: cd docs && npm install
+      - name: "Install ImageMagick"
+        run: sudo apt-get update && sudo apt-get install -y imagemagick
       - name: "Build and deploy"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/make.jl

@@ -190,6 +190,14 @@ function fix_vitepress_base_path()
         "/SymbolicRegression.jl/dev/"
     end
 
+    # The version picker should link to sibling versions that live one
+    # directory above the active version, e.g. `/symbolicregression/v1.12.0/`.
+    # Compute that shared prefix (always the first path segment) so that we can
+    # rewrite `__DEPLOY_ABSPATH__` accordingly.
+    stripped = isempty(base_path) ? base_path : rstrip(base_path, '/')
+    segments = split(stripped, '/'; keepempty=false)
+    deploy_abspath = isempty(segments) ? "/" : "/" * first(segments) * "/"
+
     # Find and fix VitePress SOURCE config file (before build)
     config_paths = [joinpath(@__DIR__, "src", ".vitepress", "config.mts")]
 
@@ -201,18 +209,57 @@ function fix_vitepress_base_path()
             # Replace the base path with the correct one for this deployment
             # Look for existing base: '...' patterns and replace them
             content = replace(content, r"base:\s*'[^']*'" => "base: '$base_path'")
+            content = replace(
+                content,
+                r"__DEPLOY_ABSPATH__\s*:\s*JSON\.stringify\('[^']*'\)" =>
+                    "__DEPLOY_ABSPATH__: JSON.stringify('$deploy_abspath')",
+            )
 
             write(config_path, content)
-            @info "Updated VitePress base path to: $base_path"
+            @info "Updated VitePress base path to: $base_path (deploy abspath: $deploy_abspath)"
         else
             @warn "VitePress config not found at: $config_path"
         end
     end
 end
 
+# Generate favicon files from logo.png
+function generate_favicons()
+    logo_path = joinpath(@__DIR__, "src", "assets", "logo.png")
+    public_dir = joinpath(@__DIR__, "src", "public")
+
+    if !isfile(logo_path)
+        @warn "Logo file not found at: $logo_path - skipping favicon generation"
+        return false
+    end
+
+    mkpath(public_dir)
+
+    @info "Generating favicon files from logo.png..."
+
+    # Generate different sizes
+    favicon_configs = [
+        ("favicon.ico", "32x32"),
+        ("favicon-16x16.png", "16x16"),
+        ("favicon-32x32.png", "32x32"),
+        ("apple-touch-icon.png", "180x180"),
+    ]
+
+    for (filename, size) in favicon_configs
+        output_path = joinpath(public_dir, filename)
+        run(`magick $(logo_path) -resize $(size) -background none -gravity center -extent $(size) $(output_path)`)
+        @info "Generated: $filename"
+    end
+
+    return true
+end
+
 # Run preprocessing on source files before makedocs()
 preprocess_source_index()
 
+# Generate favicons before building docs
+generate_favicons()
+
 # Fix VitePress base path BEFORE makedocs() - this is crucial for timing!
 fix_vitepress_base_path()
 
@@ -240,6 +287,20 @@ else
     )
 end
 
+current_version = let
+    version = get(ENV, "DOCUMENTER_VERSION", nothing)
+    if version !== nothing && !isempty(version)
+        version
+    else
+        fallback = get(ENV, "DOCUMENTER_CURRENT_VERSION", nothing)
+        if fallback !== nothing && !isempty(fallback)
+            fallback
+        else
+            "dev"
+        end
+    end
+end
+
 DocMeta.setdocmeta!(
     SymbolicRegression,
     :DocTestSetup,
@@ -250,6 +311,7 @@ DocMeta.setdocmeta!(
 makedocs(;
     sitename="SymbolicRegression.jl",
     authors="Miles Cranmer",
+    current_version=current_version,
     doctest=true,
     clean=get(ENV, "DOCUMENTER_PRODUCTION", "false") == "true",
     warnonly=[:docs_block, :cross_references, :missing_docs],
@@ -291,9 +353,19 @@ post_process_vitepress_index()
 function fix_empty_bases()
     bases_file = joinpath(@__DIR__, "build", "bases.txt")
     mkpath(dirname(bases_file))
-    if !isfile(bases_file) || isempty(filter(!isempty, readlines(bases_file)))
-        @info "Creating/fixing bases.txt for deployment"
+
+    if !isfile(bases_file)
+        @info "Creating bases.txt for dev deployment"
         write(bases_file, "dev\n")
+    else
+        bases = filter(!isempty, readlines(bases_file))
+        if isempty(bases)
+            @info "Fixing empty bases.txt for dev deployment"
+            write(bases_file, "dev\n")
+        else
+            @info "bases.txt already exists with $(length(bases)) bases: $bases"
+            # Don't overwrite it - DocumenterVitepress may have generated multiple bases
+        end
     end
 end
 

docs/src/.vitepress/config.mts

@@ -19,6 +19,13 @@ const navTemp = {
 
 const nav = [
   ...navTemp.nav,
+  {
+    text: 'Julia',
+    items: [
+      { text: 'Julia', link: '/' },
+      { text: 'Python', link: 'https://ai.damtp.cam.ac.uk/pysr/dev/' }
+    ]
+  },
   {
     component: 'VersionPicker'
   }
@@ -33,7 +40,11 @@ export default defineConfig({
   cleanUrls: true,
   outDir: 'REPLACE_ME_DOCUMENTER_VITEPRESS', // This is required for MarkdownVitepress to work correctly...
   head: [
-    ['link', { rel: 'icon', href: `${baseTemp.base}favicon.ico` }],
+    ['link', { rel: 'icon', type: 'image/x-icon', href: `${baseTemp.base}favicon.ico` }],
+    ['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: `${baseTemp.base}favicon-16x16.png` }],
+    ['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: `${baseTemp.base}favicon-32x32.png` }],
+    ['link', { rel: 'apple-touch-icon', sizes: '180x180', href: `${baseTemp.base}apple-touch-icon.png` }],
+    ['link', { rel: 'stylesheet', href: `${baseTemp.base}nav-logo.css` }],
     ['script', {src: `${getBaseRepository(baseTemp.base)}versions.js`}],
     // ['script', {src: '/versions.js'], for custom domains, I guess if deploy_url is available.
     ['script', {src: `${baseTemp.base}siteinfo.js`}]

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

@@ -90,3 +90,11 @@ html.dark {
   border-top: 1px solid var(--vp-c-divider);
   padding-top: 48px;
 }
+
+/* Make language picker match version picker styling (black text, not colored) */
+.VPNavBarMenuGroup button .text {
+  color: var(--vp-c-text-1) !important;
+}
+.VPNavBarMenuGroup:hover button .text {
+  color: var(--vp-c-text-2) !important;
+}

docs/src/public/nav-logo.css

@@ -0,0 +1,4 @@
+.VPNavBarTitle .VPImage.logo {
+  height: 24px;
+  width: auto;
+}