docs: add NavBar (#5)

Author: Beforerr

.github/workflows/documentation.yml

@@ -11,21 +11,21 @@ on:
   pull_request:
   workflow_dispatch:
 
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
 jobs:
   build:
     permissions:
+      actions: write # needed to allow julia-actions/cache to proactively delete old caches that it has created
       contents: write
       pull-requests: read
       statuses: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v2
-      - uses: julia-actions/cache@v2
       - uses: extractions/setup-just@v3
-      - name: Install LibAACGM.jl
-        run: just install && just install_lib docs
-      - name: Build and deploy
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
-        run: julia --project=docs/ docs/make.jl
+      - name: Build and deploy Documenter.jl docs
+        uses: JuliaSpacePhysics/actions/DocsDocumenter@main

LibAACGM/src/LibAACGM.jl

@@ -10,29 +10,37 @@ export AACGM_v2_SetDateTime, AACGM_v2_SetNow
 export AACGM_v2_Convert, AACGM_v2_Rylm, AACGM_v2_Rylm!
 export convert_geo_coord_v2
 
+function set_env()
+    AACGM_v2_DAT_PREFIX = joinpath(@__DIR__, "../../data/aacgm_coeffs-14/aacgm_coeffs-14-")
+    ENV["AACGM_v2_DAT_PREFIX"] = AACGM_v2_DAT_PREFIX
+    ENV["IGRF_COEFFS"] = joinpath(@__DIR__, "../../data/magmodel_1590-2025.txt")
+end
+
 # Find the library path
 function find_library(name="aacgmlib")
-    search_paths = [
-        joinpath(@__DIR__, ".."),
+    search_paths = (
+        dirname(@__DIR__),
         "/usr/local/lib",
         "/usr/lib"
-    ]
+    )
 
     # Try to find the library
     for path in search_paths
         aacgmlib = joinpath(path, "$name.so")
         isfile(aacgmlib) && return aacgmlib
     end
-    return name
+    # if not try to install it
+    @info "AACGM library not found, trying to install" run(`just install`)
+    for path in search_paths
+        aacgmlib = joinpath(path, "$name.so")
+        isfile(aacgmlib) && return aacgmlib
+    end
+    error("AACGM library not found")
 end
 
 const aacgmlib = find_library()
 
-function __init__()
-    AACGM_v2_DAT_PREFIX = joinpath(@__DIR__, "../../data/aacgm_coeffs-14/aacgm_coeffs-14-")
-    ENV["AACGM_v2_DAT_PREFIX"] = AACGM_v2_DAT_PREFIX
-    ENV["IGRF_COEFFS"] = joinpath(@__DIR__, "../../data/magmodel_1590-2025.txt")
-end
+__init__() = set_env()
 
 AACGM_v2_SetNow() = @ccall aacgmlib.AACGM_v2_SetNow()::Int
 AACGM_v2_SetDateTime(yr, mo, dy, hr, mt, sc) =

docs/Project.toml

@@ -5,3 +5,6 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 LibAACGM = "ee618599-6bd6-46be-807e-a23e17005c2b"
 PrettyPrinting = "54e16d92-306c-5ea0-a30b-337be88ac337"
+
+[sources]
+LibAACGM = { path = "../LibAACGM" }