Update to Documenter v1.0 (#16)

* Update docs/Project.toml for Documenter v1.0 * makedocs(;plugins=[bib], ...) for Documenter.jl v1 This is a breaking change in Documenter.jl v1 * Fix doc typos in Burial.jl
PALEOtoolkit · Sep 23, 2023 · 9477377 · 9477377
1 parent c2c5b48
commit 9477377
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -7,7 +7,7 @@ PALEOocean = "41de04b1-2efd-44ae-92ae-39d71a4fd99b"
 Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
 
 [compat]
-Documenter = "0.27"
+Documenter = "1.0"
 DocumenterCitations = "1.0"
 Revise = "3.1"
 julia = "1.6"
diff --git a/docs/make.jl b/docs/make.jl
@@ -22,7 +22,8 @@ examples_pages, examples_includes = PB.collate_markdown(
 # include files that load modules etc from PALEOexamples folders
 include.(examples_includes)
 
-makedocs(bib, sitename="PALEOocean Documentation", 
+makedocs(;
+    sitename = "PALEOocean Documentation", 
     pages = [
         "index.md",
         "Examples and Tutorials" => examples_pages,
@@ -40,6 +41,7 @@ makedocs(bib, sitename="PALEOocean Documentation",
     format = Documenter.HTML(
         prettyurls = get(ENV, "CI", nothing) == "true"
     ),
+    plugins = [bib],
 )
 
 @info "Local html documentation is available at $(joinpath(@__DIR__, "build/index.html"))"

diff --git a/src/oceanfloor/Burial.jl b/src/oceanfloor/Burial.jl
@@ -341,11 +341,11 @@ Base.@kwdef mutable struct ReactionBurialEffCorgP{P} <: PB.AbstractReaction
         PB.ParDoubleVec("BPO2", [NaN], units="mol O2 m-3",
             description="[O2] points for interpolated oxygen-dependent P:Corg (length 1 for O2-independent P:Corg)"),
         PB.ParDoubleVec("BPorgCorg", [0.0], units="mol P (mol Corg)-1",
-            description="P:Corg for organic P burial fraction at each [O2] (Vector length 1 for O2-independent P:Corg)"),
+            description="P:Corg for organic P burial fraction at each BPO2 (Vector length 1 for O2-independent P:Corg)"),
         PB.ParDoubleVec("BPFeCorg", [0.0], units="mol P (mol Corg)-1",
-            description="P:Corg for Fe-associated P burial fraction at each [O2] (Vector length 1 for O2-independent P:Corg)"),
+            description="P:Corg for Fe-associated P burial fraction at each BPO2 (Vector length 1 for O2-independent P:Corg)"),
         PB.ParDoubleVec("BPauthCorg", [0.0], units="mol P (mol Corg)-1",
-            description="P:Corg for CFA-associated P burial fraction at each [O2] (Vector length 1 for O2-independent P:Corg)"),
+            description="P:Corg for CFA-associated P burial fraction at each BPO2 (Vector length 1 for O2-independent P:Corg)"),
 
         PB.ParType(PB.AbstractData, "CIsotope", PB.ScalarData,
             external=true,