Skip to content

Commit 95ad37c

Browse files
authored
Update Documenter, DocumenterCitations (PALEOtoolkit#30)
* Update Documenter, DocumenterCitations * makedocs(; plugins=[bib], ...) update Breaking change in Documenter.jl v1 * style=:authoryear for references * Update Documenter [compat] in top-level Project.toml
1 parent 5b9c700 commit 95ad37c

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ XLSX = "fdbf4ff8-1666-58a4-91e7-1b58723a45e0"
1717

1818
[compat]
1919
DataFrames = "1.1"
20-
Documenter = "0.27"
20+
Documenter = "1"
2121
Infiltrator = "1.0"
2222
Interpolations = "0.13, 0.14"
2323
MAT = "0.10"

docs/Project.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[compat]
2-
Documenter = "0.27"
3-
DocumenterCitations = "0.2"
2+
Documenter = "1"
3+
DocumenterCitations = "1"
44
Revise = "3.1"
55
julia = "1.6"
66

docs/make.jl

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,13 @@ import PALEOcopse
44

55
using DocumenterCitations
66

7-
bib = CitationBibliography(joinpath(@__DIR__, "src/paleo_references.bib"))
7+
bib = CitationBibliography(
8+
joinpath(@__DIR__, "src/paleo_references.bib");
9+
style=:authoryear,
10+
)
811

9-
makedocs(bib, sitename="PALEOcopse Documentation",
10-
# makedocs(sitename="PALEO Documentation",
12+
makedocs(;
13+
sitename = "PALEOcopse Documentation",
1114
pages = [
1215
"index.md",
1316
"Examples and Tutorials" => [
@@ -16,7 +19,7 @@ makedocs(bib, sitename="PALEOcopse Documentation",
1619
"Design" => [
1720
"COPSE_Domains.md",
1821
],
19-
# no HOWTO docs yes
22+
# no HOWTO docs yet
2023
"Reference" => [
2124
"PALEOcopse.md",
2225
],
@@ -26,6 +29,7 @@ makedocs(bib, sitename="PALEOcopse Documentation",
2629
format = Documenter.HTML(
2730
prettyurls = get(ENV, "CI", nothing) == "true"
2831
),
32+
plugins = [bib],
2933
)
3034

3135
@info "Local html documentation is available at $(joinpath(@__DIR__, "build/index.html"))"

0 commit comments

Comments
 (0)