Get references working

SmoQySuite · Oct 14, 2023 · 6d1040a · 6d1040a
1 parent ccfd822
commit 6d1040a
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -16,5 +16,6 @@ A very similar Julia package implementing and exporting many of the same algorit
 To install [`StableLinearAlgebra.jl`](https://github.com/SmoQySuite/StableLinearAlgebra.jl) run following in the Julia REPL:
 
 ```julia
-] add StableLinearAlgebra
+julia> ]
+pkg> add StableLinearAlgebra
 ```
diff --git a/docs/make.jl b/docs/make.jl
@@ -3,11 +3,14 @@ using Documenter
 using DocumenterCitations
 using LinearAlgebra
 
+bib = CitationBibliography(
+    joinpath(@__DIR__, "src", "references.bib");
+    style=:numeric
+)
 DocMeta.setdocmeta!(StableLinearAlgebra, :DocTestSetup, :(using StableLinearAlgebra); recursive=true)
-bib = CitationBibliography(joinpath(@__DIR__, "references.bib"), sorting = :nyt)
 
-makedocs(
-    bib,
+makedocs(;
+    plugins=[bib],
     modules=[StableLinearAlgebra],
     authors="Benjamin Cohen-Stead <[email protected]>",
     repo="https://github.com/SmoQySuite/StableLinearAlgebra.jl/blob/{commit}{path}#{line}",

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -15,10 +15,12 @@ A very similar Julia package implementing and exporting many of the same algorit
 To install [`StableLinearAlgebra.jl`](https://github.com/SmoQySuite/StableLinearAlgebra.jl) run following in the Julia REPL:
 
 ```julia
-] add StableLinearAlgebra
+julia> ]
+pkg> add StableLinearAlgebra
 ```
 
 ## References
 
 ```@bibliography
-```
+*
+```
diff --git a/docs/references.bib → docs/src/references.bib b/docs/references.bib → docs/src/references.bib
diff --git a/src/overloaded_functions.jl b/src/overloaded_functions.jl
@@ -57,7 +57,7 @@ copyto!(U::LDR, I::UniformScaling, ignore...) = ldr!(U,I)
 @doc raw"""
     copyto!(U::LDR{T,E}, V::LDR{T,E}, ignore...) where {T,E}
 
-Copy the ['LDR'](@ref) factorization `V` to `U`.
+Copy the [`LDR`](@ref) factorization `V` to `U`.
 """
 copyto!(U::LDR{T,E}, V::LDR{T,E}, ignore...) where {T,E} = ldr!(U, V)