Use DocumenterCitations.jl (#330)

* Restrict version of `ComplexityMeasures`

Fixes #325

* Use DocumenterCitations.jl for references

* DocumenterCitations should be in `docs/Project.toml`

Author: kahaaga

Project.toml

@@ -2,7 +2,7 @@ name = "CausalityTools"
 uuid = "5520caf5-2dd7-5c5d-bfcb-a00e56ac49f7"
 authors = ["Kristian Agasøster Haaga <kahaaga@gmail.com>", "Tor Einar Møller <temolle@gmail.com>", "George Datseris <datseris.george@gmail.com>"]
 repo = "https://github.com/kahaaga/CausalityTools.jl.git"
-version = "2.8.0"
+version = "2.9.0"
 
 [deps]
 Accessors = "7d9f7c33-5ae7-4f3b-8dc6-eff91059b697"
@@ -12,6 +12,7 @@ DSP = "717857b8-e6f2-59f4-9121-6e50c889abd2"
 DelayEmbeddings = "5732040d-69e3-5649-938a-b6b4f237613f"
 Distances = "b4f34e82-e78d-54a5-968a-f98e89d6e8f7"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DynamicalSystemsBase = "6e36e845-645a-534a-86f2-f5d4aa5a06b4"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 HypothesisTests = "09f84164-cd44-5f33-b23f-e6b0d136a0d5"
@@ -35,7 +36,7 @@ TimeseriesSurrogates = "c804724b-8c18-5caa-8579-6025a0767c70"
 [compat]
 Accessors = "^0.1.28"
 Combinatorics = "1"
-ComplexityMeasures = "2.8"
+ComplexityMeasures = "2 - 2.8"
 DSP = "0.7"
 DelayEmbeddings = "2.7"
 Distances = "^0.10"

docs/Project.toml

@@ -7,6 +7,7 @@ DelayEmbeddings = "5732040d-69e3-5649-938a-b6b4f237613f"
 Distances = "b4f34e82-e78d-54a5-968a-f98e89d6e8f7"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
 DynamicalSystemsBase = "6e36e845-645a-534a-86f2-f5d4aa5a06b4"
 GraphMakie = "1ecd5474-83a3-4783-bb4f-06765db800d2"
@@ -24,5 +25,5 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 TimeseriesSurrogates = "c804724b-8c18-5caa-8579-6025a0767c70"
 
 [compat]
-julia = "^1.6"
 DynamicalSystemsBase = "3"
+julia = "^1.6"

docs/make.jl

@@ -1,36 +1,15 @@
 cd(@__DIR__)
-using Pkg
-CI = get(ENV, "CI", nothing) == "true" || get(ENV, "GITHUB_TOKEN", nothing) !== nothing
-CI && Pkg.activate(@__DIR__)
-CI && Pkg.instantiate()
-ENV["GKSwstype"] = "100" # allow local builds without output
-using Documenter
-using DocumenterTools: Themes
+# Doc-specific (remaining packages are imported  in `build_docs_with_style.jl`, which is
+# downloaded)
+using DocumenterCitations
+import Downloads
+
+# Packages used in the doc build.
 using CausalityTools
 using ComplexityMeasures
 using StateSpaceSets
 
-# %% JuliaDynamics theme.
-# download the themes
-using DocumenterTools: Themes
-for file in ("juliadynamics-lightdefs.scss", "juliadynamics-darkdefs.scss", "juliadynamics-style.scss")
-    download("https://raw.githubusercontent.com/JuliaDynamics/doctheme/master/$file", joinpath(@__DIR__, file))
-end
-# create the themes
-for w in ("light", "dark")
-    header = read(joinpath(@__DIR__, "juliadynamics-style.scss"), String)
-    theme = read(joinpath(@__DIR__, "juliadynamics-$(w)defs.scss"), String)
-    write(joinpath(@__DIR__, "juliadynamics-$(w).scss"), header*"\n"*theme)
-end
-# compile the themes
-Themes.compile(joinpath(@__DIR__, "juliadynamics-light.scss"), joinpath(@__DIR__, "src/assets/themes/documenter-light.css"))
-Themes.compile(joinpath(@__DIR__, "juliadynamics-dark.scss"), joinpath(@__DIR__, "src/assets/themes/documenter-dark.css"))
-
-# %% Build docs
-cd(@__DIR__)
-ENV["JULIA_DEBUG"] = "Documenter"
-
-PAGES = [
+pages = [
     "Overview" => "index.md",
     "Association measures" => "measures.md",
     "Independence testing" => "independence.md",
@@ -39,26 +18,23 @@ PAGES = [
     "Examples" => "examples.md",
     "Predefined systems" => "coupled_systems.md",
     "Experimental" => "experimental.md",
+    "References" => "references.md",
 ]
 
-makedocs(
-    modules = [CausalityTools, ComplexityMeasures, StateSpaceSets],
-    format = Documenter.HTML(
-        prettyurls = CI,
-        sidebar_sitename = false,
-        assets = [
-            asset("https://fonts.googleapis.com/css?family=Montserrat|Source+Code+Pro&display=swap", class=:css),
-        ],
-        ),
-    sitename = "CausalityTools.jl",
-    authors = "Kristian Agasøster Haaga, David Diego, Tor Einar Møller, George Datseris",
-    pages = PAGES
+Downloads.download(
+    "https://raw.githubusercontent.com/JuliaDynamics/doctheme/master/build_docs_with_style.jl",
+    joinpath(@__DIR__, "build_docs_with_style.jl")
 )
+include("build_docs_with_style.jl")
 
-if CI
-    deploydocs(
-        repo = "github.com/JuliaDynamics/CausalityTools.jl.git",
-        target = "build",
-        push_preview = true
-    )
-end
+bibliography = CitationBibliography(
+    joinpath(@__DIR__, "refs.bib");
+    style=:authoryear
+)
+
+build_docs_with_style(pages, CausalityTools, ComplexityMeasures, StateSpaceSets;
+    expandfirst = ["index.md"],
+    bib = bibliography,
+    pages = pages,
+    authors = "Kristian Agasøster Haaga, David Diego, Tor Einar Møller, George Datseris",
+)