Use DocumenterCitations.jl to manage references

Author: abhro

docs/Project.toml

@@ -1,5 +1,6 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 Interpolations = "a98d9a8b-a2ab-59e6-89dd-64a1c18fca59"
 
 [compat]

docs/make.jl

@@ -1,4 +1,5 @@
 using Documenter
+using DocumenterCitations
 using Interpolations
 
 DocMeta.setdocmeta!(
@@ -7,6 +8,12 @@ DocMeta.setdocmeta!(
     :(using Interpolations),
     recursive = true,
 )
+
+bib = CitationBibliography(
+    joinpath(@__DIR__, "src", "refs.bib"),
+    style = :authoryear,
+)
+
 makedocs(
     sitename = "Interpolations.jl",
     modules = [Interpolations],
@@ -24,9 +31,11 @@ makedocs(
         "Library" => "api.md",
         "News and Changes" => "NEWS.md",
         "Other Interpolation Packages" => "other_packages.md",
+        "Bilbiography" => "bibliography.md",
     ],
     warnonly = false,
     doctest = true,
+    plugins = [bib],
 )
 
 deploydocs(

docs/src/api.md

@@ -12,3 +12,9 @@ Modules = [Interpolations]
 Public = false
 Order = [:function, :type]
 ```
+
+## Bibliography
+```@bibliography
+Pages = ["api.md"]
+Canonical = false
+```

docs/src/bibliography.md

@@ -0,0 +1,8 @@
+# Bibliography
+
+```@bibliography
+```
+
+```@bibliography
+*
+```

docs/src/control.md

@@ -241,7 +241,11 @@ There are a few different monotonic interpolation algorithms. Some guarantee tha
 * [`SteffenMonotonicInterpolation`](@ref) -- it does not overshoot.
 
 You can read about monotonic interpolation in the following sources:
+```@bibliography
+Pages = []
+Canonical = false
 
-* Fritsch & Carlson (1980), "Monotone Piecewise Cubic Interpolation", doi:10.1137/0717021.
-* Fritsch & Butland (1984), "A Method for Constructing Local Monotone Piecewise Cubic Interpolants", doi:10.1137/0905021.
-* Steffen (1990), "A Simple Method for Monotonic Interpolation in One Dimension", [URL](http://adsabs.harvard.edu/abs/1990A%26A...239..443S)
+Fritsch1980
+Fritsch1984
+Steffen1990
+```

docs/src/devdocs.md

@@ -239,3 +239,9 @@ Also, all GPU-compatable `AbstractInterpolation`s should define their own
 broadcast mechanism by overloading the default `BroadcastStyle`. See
 [Customizing broadcasting](https://docs.julialang.org/en/v1/manual/interfaces/#man-interfaces-broadcasting)
 for more details.
+
+
+```@bibliography
+Pages = ["devdocs.md"]
+Canonical = false
+```

docs/src/refs.bib

@@ -0,0 +1,70 @@
+@article{Thévenaz2000,
+author = {Th\'evenaz, P. and Blu, T. and Unser, M.},
+journal = {IEEE Transactions on Medical Imaging},
+title = {Interpolation revisited},
+year = {2000},
+volume = {19},
+number = {7},
+pages = {739-758},
+doi = {10.1109/42.875199}
+}
+
+@article{Fritsch1980,
+author = {Fritsch, F. N. and Carlson, R. E.},
+title = {Monotone Piecewise Cubic Interpolation},
+journal = {SIAM Journal on Numerical Analysis},
+volume = {17},
+number = {2},
+pages = {238-246},
+year = {1980},
+doi = {10.1137/0717021},
+}
+
+@article{Fritsch1984,
+author = {Fritsch, F. N. and Butland, J.},
+title = {A Method for Constructing Local Monotone Piecewise Cubic Interpolants},
+journal = {SIAM Journal on Scientific and Statistical Computing},
+volume = {5},
+number = {2},
+pages = {300-304},
+year = {1984},
+doi = {10.1137/0905021},
+}
+
+@article{Steffen1990,
+author = {{Steffen}, M.},
+title = "{A Simple Method for Monotonic Interpolation in One Dimension}",
+journal = {Astronomy and Astrophysics},
+year = {1990},
+volume = {239},
+pages = {443-450},
+url = {https://adsabs.harvard.edu/abs/1990A%26A...239..443S},
+}
+
+@article{Eilers1996,
+author = {Paul H. C. Eilers and Brian D. Marx},
+title = {Flexible smoothing with B-splines and penalties},
+volume = {11},
+journal = {Statistical Science},
+number = {2},
+publisher = {Institute of Mathematical Statistics},
+pages = {89 -- 121},
+year = {1996},
+doi = {10.1214/ss/1038425655},
+url = {https://projecteuclid.org/euclid.ss/1038425655},
+}
+
+@article{Akima1970,
+author = {Akima, Hiroshi},
+title = {A New Method of Interpolation and Smooth Curve Fitting Based on Local Procedures},
+year = {1970},
+publisher = {Association for Computing Machinery},
+address = {New York, NY, USA},
+volume = {17},
+number = {4},
+issn = {0004-5411},
+doi = {10.1145/321607.321609},
+journal = {J. ACM},
+pages = {589--602},
+numpages = {14},
+}

src/b-splines/b-splines.jl

@@ -213,7 +213,8 @@ a polynomial of order `k-1`. A value of 2 is the most common.
 
 `λ` is non-negative. If its value is zero, it falls back to non-regularized interpolation.
 
-[1] https://projecteuclid.org/euclid.ss/1038425655.
+# References
+- [Eilers and Marx, 1996, Statist. Sci. 11(2), 1996](@cite Eilers1996)
 """
 function interpolate(A::AbstractArray, it::IT, λ::Real, k::Int) where {IT<:DimSpec{BSpline}}
     interpolate(tweight(A), tcoef(A), A, it, λ, k)

src/monotonic/monotonic.jl

@@ -71,9 +71,9 @@ end
 """
     AkimaMonotonicInterpolation
 
-Monotonic interpolation based on Akima (1970),
+Monotonic interpolation based on [Akima (1970)
 "A New Method of Interpolation and Smooth Curve Fitting Based on Local Procedures",
-doi:10.1145/321607.321609.
+doi:10.1145/321607.321609](@cite Akima1970).
 
 Tangents are determined at each given point locally,
 results are close to manual drawn curves
@@ -84,8 +84,8 @@ end
 """
     FritschCarlsonMonotonicInterpolation
 
-Monotonic interpolation based on Fritsch & Carlson (1980),
-"Monotone Piecewise Cubic Interpolation", doi:10.1137/0717021.
+Monotonic interpolation based on [Fritsch & Carlson (1980),
+"Monotone Piecewise Cubic Interpolation", doi:10.1137/0717021](@cite Fritsch1980).
 
 Tangents are first initialized, then adjusted if they are not monotonic
 can overshoot for non-monotonic data
@@ -96,9 +96,9 @@ end
 """
     FritschButlandMonotonicInterpolation
 
-Monotonic interpolation based on  Fritsch & Butland (1984),
+Monotonic interpolation based on [Fritsch & Butland (1984),
 "A Method for Constructing Local Monotone Piecewise Cubic Interpolants",
-doi:10.1137/0905021.
+doi:10.1137/0905021](@cite Fritsch1984).
 
 Faster than FritschCarlsonMonotonicInterpolation (only requires one pass)
 but somewhat higher apparent "tension".
@@ -109,9 +109,9 @@ end
 """
     SteffenMonotonicInterpolation
 
-Monotonic interpolation based on Steffen (1990),
+Monotonic interpolation based on [Steffen (1990),
 "A Simple Method for Monotonic Interpolation in One Dimension",
-http://adsabs.harvard.edu/abs/1990A%26A...239..443S
+http://adsabs.harvard.edu/abs/1990A%26A...239..443S](@cite Steffen1990)
 
 Only one pass, results usually between FritschCarlson and FritschButland.
 """