edits

kestrelquantum · Feb 22, 2024 · db31bb9 · db31bb9
1 parent 1e1efe5
commit db31bb9
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 50 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -16,11 +16,11 @@ jobs:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v1
         with:
-          version: '1.9'
+          version: '1.10'
       - name: Install dependencies
-        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+        run: julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
       - name: Build and deploy
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
-        run: julia --project=docs/ docs/make.jl
+        run: julia --project=docs docs/make.jl
diff --git a/docs/make.jl b/docs/make.jl
@@ -4,15 +4,52 @@ using Literate
 
 push!(LOAD_PATH, joinpath(@__DIR__, "..", "src"))
 
-# DocMeta.setdocmeta!(
-#     NamedTrajectories,
-#     :DocTestSetup,
-#     :(using NamedTrajectories);
-#     recursive=true
-# )
+pages = [
+    "Home" => "index.md",
+    "Quickstart Guide" => "generated/quickstart.md",
+    # "Manual" => [
+    #     "generated/man/constructors.md",
+    #     "generated/man/retrieval.md",
+    #     "generated/man/add_remove.md",
+    #     "generated/man/updating.md",
+    #     "generated/man/times.md",
+    #     "generated/man/operations.md",
+    # ],
+    "Plotting" => "generated/plotting.md",
+    "Library" => "lib.md"
+]
+
+format = Documenter.HTML(;
+    prettyurls=get(ENV, "CI", "false") == "true",
+    canonical="https://aarontrowbridge.github.io/NamedTrajectories.jl",
+    edit_link="main",
+    assets=String[],
+    mathengine = MathJax3(Dict(
+        :loader => Dict("load" => ["[tex]/physics"]),
+        :tex => Dict(
+            "inlineMath" => [["\$","\$"], ["\\(","\\)"]],
+            "tags" => "ams",
+            "packages" => [
+                "base",
+                "ams",
+                "autoload",
+                "physics"
+            ],
+            "macros" => Dict(
+                "minimize" => ["\\underset{#1}{\\operatorname{minimize}}", 1],
+            )
+        ),
+        # :TeX => Dict(
+        #     :Macros => Dict(
+        #         :minimize => ["\\underset{#1}{\\operatorname{minimize}}", 1],
+        #     )
+        # )
+    )),
+)
 
 src = joinpath(@__DIR__, "src")
 lit = joinpath(@__DIR__, "literate")
+
 lit_output = joinpath(src, "generated")
 
 for (root, _, files) ∈ walkdir(lit), file ∈ files
@@ -26,47 +63,8 @@ makedocs(;
     modules=[NamedTrajectories],
     authors="Aaron Trowbridge <aaron.j.trowbridge@gmail.com> and contributors",
     sitename="NamedTrajectories.jl",
-    format=Documenter.HTML(;
-        prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://aarontrowbridge.github.io/NamedTrajectories.jl",
-        edit_link="main",
-        assets=String[],
-        mathengine = MathJax3(Dict(
-            :loader => Dict("load" => ["[tex]/physics"]),
-            :tex => Dict(
-                "inlineMath" => [["\$","\$"], ["\\(","\\)"]],
-                "tags" => "ams",
-                "packages" => [
-                    "base",
-                    "ams",
-                    "autoload",
-                    "physics"
-                ],
-                "macros" => Dict(
-                    "minimize" => ["\\underset{#1}{\\operatorname{minimize}}", 1],
-                )
-            ),
-            # :TeX => Dict(
-            #     :Macros => Dict(
-            #         :minimize => ["\\underset{#1}{\\operatorname{minimize}}", 1],
-            #     )
-            # )
-        )),
-    ),
-    pages=[
-        "Home" => "index.md",
-        "Quickstart Guide" => "generated/quickstart.md",
-        # "Manual" => [
-        #     "generated/man/constructors.md",
-        #     "generated/man/retrieval.md",
-        #     "generated/man/add_remove.md",
-        #     "generated/man/updating.md",
-        #     "generated/man/times.md",
-        #     "generated/man/operations.md",
-        # ],
-        "Plotting" => "generated/plotting.md",
-        "Library" => "lib.md"
-    ],
+    format=format,
+    pages=pages,
 )
 
 deploydocs(;