Add DocumenterCitations

JuliaSurv · Mar 22, 2024 · 1255462 · 1255462
1 parent def4aee
commit 1255462
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 0 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,3 +1,5 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
+LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 NetSurvival = "8f9d5d0e-dd2e-4568-92d4-f8c5d34f25cf"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,10 +1,17 @@
 using NetSurvival
 using Documenter
+using DocumenterCitations
 
 DocMeta.setdocmeta!(NetSurvival, :DocTestSetup, :(using NetSurvival); recursive=true)
 
+bib = CitationBibliography(
+    joinpath(@__DIR__,"src","assets","references.bib"),
+    style=:numeric
+)
+
 makedocs(;
     modules=[NetSurvival],
+    plugins=[bib],
     authors="Oskar Laverny <[email protected]> and contributors",
     sitename="NetSurvival.jl",
     format=Documenter.HTML(;

diff --git a/docs/src/assets/references.bib b/docs/src/assets/references.bib
@@ -0,0 +1,10 @@
+@article{PoharPerme2012,
+  title={On estimation in relative survival},
+  author={Perme, Maja Pohar and Stare, Janez and Est{\`e}ve, Jacques},
+  journal={Biometrics},
+  volume={68},
+  number={1},
+  pages={113--120},
+  year={2012},
+  publisher={Oxford University Press}
+}
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -6,9 +6,15 @@ CurrentModule = NetSurvival
 
 Documentation for [NetSurvival](https://github.com/JuliaSurv/NetSurvival.jl).
 
+This is an example reference : [PoharPerme2012](@cite).
+
+
 ```@index
 ```
 
 ```@autodocs
 Modules = [NetSurvival]
 ```
+
+```@bibliography
+```