update docs

cecoeco · Sep 13, 2024 · feddb23 · feddb23
1 parent 380a9da
commit feddb23
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -25,8 +25,7 @@ create and save a flow diagram:
 ```julia
 using PRISMA
 
-fd::FlowDiagram = flow_diagram() 
-flow_diagram_save("flow_diagram.svg", fd)
+flow_diagram_save("flow_diagram.svg", flow_diagram())
 ```
 
 output:

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -4,7 +4,7 @@ DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 PRISMA = "7b67a8d2-c4f5-4933-b91c-0fc427024db5"
 
 [compat]
-Documenter = "1.3"
+Documenter = "1.7"
 DocumenterCitations = "1.3"
-PRISMA = "0.0.7, 0.0.6"
+PRISMA = "0.0.7"
 julia = "1"
diff --git a/docs/make.jl b/docs/make.jl
@@ -21,7 +21,7 @@ Documenter.makedocs(
     plugins=[
         DocumenterCitations.CitationBibliography(
             joinpath(ASSETS, "references.bib"),
-            style=:authoryear
+            style=:numeric
         )
     ]
 )

diff --git a/docs/src/assets/bib.css b/docs/src/assets/bib.css
@@ -15,7 +15,7 @@
 .citation ul {
     padding: 0 0 2.25em 0;
     margin: 0;
-    list-style: none;
+    list-style: none !important;
 }
 
 .citation ul li {

diff --git a/src/checklist_docstrings.jl b/src/checklist_docstrings.jl
@@ -86,7 +86,7 @@ returns a template PRISMA checklist as a `DataFrame`
 ```jldoctest
 julia> using PRISMA
 
-julia> println(checklist_df())
+julia> checklist_df()
 49×4 DataFrame
  Row │ Section and Topic                  Item #  Checklist Item                     Location where item is reported 
      │ String                             String  String                             String                          
@@ -167,7 +167,7 @@ julia> using PRISMA
 julia> checklist_template()
 "checklist.csv"
 
-julia> println(checklist_read("checklist.csv"))
+julia> checklist_read("checklist.csv")
 49×4 DataFrame
  Row │ Section and Topic                  Item #  Checklist Item                     Location where item is reported 
      │ String                             String  String                             String                          

diff --git a/src/flow_diagram_docstrings.jl b/src/flow_diagram_docstrings.jl
@@ -102,7 +102,7 @@ returns the template that is used to create the flow diagram as a `DataFrame`.
 ```jldoctest
 julia> using PRISMA
 
-julia> println(flow_diagram_df())
+julia> flow_diagram_df()
 41×3 DataFrame
  Row │ box_num  box_text                           result  
      │ Int64    String                             Int64?  
@@ -174,7 +174,7 @@ julia> using PRISMA
 julia> flow_diagram_template()
 "flow_diagram.csv"
 
-julia> println(flow_diagram_read("flow_diagram.csv"))
+julia> flow_diagram_read("flow_diagram.csv")
 41×3 DataFrame
  Row │ box_num  box_text                           result  
      │ Int64    String                             Int64?