Switch Quarto rendering in the docs to JuliaNotebookRunner (#36)

* Switch Quarto rendering to a pure Julia solution.
* runs formatter.
* Add changelog entry

Author: kellertuer

.github/workflows/documenter.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: quarto-dev/quarto-actions/setup@v2
         with:
-          version: "1.4.551"
+          version: "1.7.29"
       - uses: julia-actions/setup-julia@latest
         with:
           version: "1.11"
@@ -40,16 +40,6 @@ jobs:
           key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('tutorials/*.qmd') }}
           restore-keys: |
             ${{ runner.os }}-${{ env.cache-name }}-
-      - name: Cache CondaPkg
-        id: cache-condaPkg
-        uses: actions/cache@v4
-        env:
-          cache-name: cache-condapkg
-        with:
-          path: docs/.CondaPkg
-          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('docs/CondaPkg.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ env.cache-name }}-
       - name: "Documenter rendering (including Quarto)"
         run: "docs/make.jl --quarto"
         env:

NEWS.md

@@ -5,6 +5,12 @@ All notable Changes to the Julia package `LieGroups.jl` will be documented in th
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.1] unreleased
+
+### Changed
+
+* the tutorials are now rendered with `quarto` using the [`QuartoNotebookRunner.jl`](https://github.com/PumasAI/QuartoNotebookRunner.jl) and are hence purely julia based.
+
 ## [0.1.0] 2025-04-22
 
 Everything denoted by “formerly” refers to the previous name in [`Manifolds.jl`](https://juliamanifolds.github.io/Manifolds.jl/stable/).

docs/CondaPkg.toml

@@ -1,14 +1,12 @@
 [deps]
-CondaPkg = "992eb4ea-22a4-4c89-a5bb-47a3300528ab"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
 LieGroups = "6774de46-80ba-43f8-ba42-e41071ccfc5f"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 
 [compat]
-CondaPkg = "0.2"
 Documenter = "1"
 DocumenterCitations = "1.3"
 DocumenterInterLinks = "1"
-LinearAlgebra = "1.11"
+LinearAlgebra = "1.11"

docs/Project.toml

@@ -67,32 +67,27 @@ end
 #
 # (b) if docs is not the current active environment, switch to it
 # (from https://github.com/JuliaIO/HDF5.jl/pull/1020/) 
+using Pkg
 if Base.active_project() != joinpath(@__DIR__, "Project.toml")
-    using Pkg
     Pkg.activate(@__DIR__)
-    # local temp hack - load ManifoldsBase and Manifold in dev as well
-    Pkg.develop(PackageSpec(; path=(@__DIR__) * "/../"))
-    Pkg.resolve()
-    Pkg.instantiate()
 end
+# load LieGroups in dev mode
+Pkg.develop(PackageSpec(; path=(@__DIR__) * "/../"))
+Pkg.resolve()
+Pkg.instantiate()
 
 # (c) If quarto is set, or we are on CI, run quarto
 if run_quarto || run_on_CI
-    using CondaPkg
-    CondaPkg.withenv() do
-        @info "Rendering Quarto"
-        tutorials_folder = (@__DIR__) * "/../tutorials"
-        # instantiate the tutorials environment if necessary
-        Pkg.activate(tutorials_folder)
-        # For a breaking release -> also set the tutorials folder to the most recent version
-        Pkg.develop(PackageSpec(; path=(@__DIR__) * "/../"))
-        Pkg.resolve()
-        Pkg.instantiate()
-        Pkg.build("IJulia") # build `IJulia` to the right version.
-        Pkg.activate(@__DIR__) # but return to the docs one before
-        run(`quarto render $(tutorials_folder)`)
-        return nothing
-    end
+    @info "Rendering Quarto"
+    tutorials_folder = (@__DIR__) * "/../tutorials"
+    # instantiate the tutorials environment if necessary
+    Pkg.activate(tutorials_folder)
+    # For a breaking release -> also set the tutorials folder to the most recent version
+    Pkg.develop(PackageSpec(; path=(@__DIR__) * "/../"))
+    Pkg.resolve()
+    Pkg.instantiate()
+    Pkg.activate(@__DIR__) # but return to the docs one before
+    run(`quarto render $(tutorials_folder)`)
 else
     # fallback to at least create empty files for tutorials that are directly linked from the docs
     touch(joinpath(@__DIR__, "src/tutorials/getstarted.md"))

docs/make.jl

@@ -344,7 +344,6 @@ function lie_bracket!(
     return fill!(Z, 0)
 end
 
-
 _doc_log_abelmult = """
     log(G::LieGroup{𝔽,<:AbelianMultiplicationGroupOperation}, h)
     log(G::LieGroup{𝔽,<:AbelianMultiplicationGroupOperation}, g, h)

src/group_operations/multiplication_operation_abelian.jl

@@ -87,4 +87,4 @@ CircleGroup(::Union{ManifoldsBase.AbstractNumbers,Circle,Euclidean,Sphere})
 
 #
 #
-# Common definitions
+# Common definitions

src/groups/circle_group.jl

@@ -178,7 +178,6 @@ function get_vector_lie!(
     return get_vector!(M, X, identity_element(G, T), c, DefaultOrthonormalBasis(ℝ))
 end
 
-
 identity_element(::_RealCircleGroup) = 0.0
 
 Base.inv(::_RealCircleGroup, p::Number) = sym_rem(-p)
@@ -201,7 +200,6 @@ function lie_bracket(
     return zero(X)
 end
 
-
 _doc_log_real_circ = """
     log(::LieGroup{ℝ, AdditionGroupOperation, Circle{ℝ}}, g)
     log!(::LieGroup{ℝ, AdditionGroupOperation, Circle{ℝ}}, X, g)
@@ -246,7 +244,6 @@ function ManifoldsBase.log!(G::_RealCircleGroup, X, ::Identity{AdditionGroupOper
     return zero_vector!(LieAlgebra(G), X)
 end
 
-
 function Base.show(io::IO, ::_RealCircleGroup)
     return print(io, "CircleGroup(ℝ)")
 end

src/groups/circle_group_real.jl

@@ -20,4 +20,4 @@ format:
     variant: -raw_html+tex_math_dollars
     wrap: preserve
 
-jupyter: julia-1.11
+engines: ['julia']