Update Documenter.jl to 1.0 (#654)

* initial changes

* fixes

* add DocumenterCitations compat bound

* remove nightly because the other PR that does that is stuck on a different change

* add source to citations.css; bump version

Project.toml

@@ -1,7 +1,7 @@
 name = "Manifolds"
 uuid = "1cead3c2-87b3-11e9-0ccd-23c62b72b94e"
 authors = ["Seth Axen <seth.axen@gmail.com>", "Mateusz Baran <mateuszbaran89@gmail.com>", "Ronny Bergmann <manopt@ronnybergmann.net>", "Antoine Levitt <antoine.levitt@gmail.com>"]
-version = "0.8.78"
+version = "0.8.79"
 
 [deps]
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"

docs/Project.toml

@@ -24,7 +24,8 @@ BoundaryValueDiffEq = "4"
 CondaPkg = "0.2"
 DiffEqCallbacks = "2"
 Distributions = "0.22.6, 0.23, 0.24, 0.25"
-Documenter = "0.27"
+Documenter = "1"
+DocumenterCitations = "1.2.1"
 FiniteDifferences = "0.12"
 Graphs = "1.4"
 HybridArrays = "0.4"

docs/make.jl

@@ -63,10 +63,12 @@ end
 
 # (e) ...finally! make docs
 bib = CitationBibliography(joinpath(@__DIR__, "src", "references.bib"); style=:alpha)
-makedocs(
-    bib;
+makedocs(;
     # for development, we disable prettyurls
-    format=Documenter.HTML(prettyurls=false, assets=["assets/favicon.ico"]),
+    format=Documenter.HTML(
+        prettyurls=false,
+        assets=["assets/favicon.ico", "assets/citations.css"],
+    ),
     modules=[
         Manifolds,
         isdefined(Base, :get_extension) ?
@@ -165,5 +167,7 @@ makedocs(
             "References" => "misc/references.md",
         ],
     ],
+    plugins=[bib],
+    warnonly=[:missing_docs],
 )
 deploydocs(repo="github.com/JuliaManifolds/Manifolds.jl.git", push_preview=true)

docs/src/assets/citations.css

@@ -0,0 +1,19 @@
+/* Taken from https://juliadocs.org/DocumenterCitations.jl/v1.2/styling/ */
+
+.citation dl {
+  display: grid;
+  grid-template-columns: max-content auto; }
+.citation dt {
+  grid-column-start: 1; }
+.citation dd {
+  grid-column-start: 2;
+  margin-bottom: 0.75em; }
+.citation ul {
+ padding: 0 0 2.25em 0;
+ margin: 0;
+ list-style: none;}
+.citation ul li {
+ text-indent: -2.25em;
+ margin: 0.33em 0.5em 0.5em 2.25em;}
+.citation ol li {
+ padding-left:0.75em;}

src/manifolds/GeneralUnitaryMatrices.jl

@@ -889,7 +889,7 @@ end
 
 Compute volume density function of a sphere, i.e. determinant of the differential of
 exponential map `exp(M, p, X)`. It is derived from Eq. (4.1) and Corollary 4.4
-in [ChevallierLiLuDunson:2022](@ref). See also Theorem 4.1 in [FalorsideHaanDavidsonForre:2019](@cite),
+in [ChevallierLiLuDunson:2022](@cite). See also Theorem 4.1 in [FalorsideHaanDavidsonForre:2019](@cite),
 (note that it uses a different convention).
 """
 function volume_density(M::GeneralUnitaryMatrices{n,ℝ}, p, X) where {n}