Merge pull request #321 from JuliaReach/schillic/bibliography

Use `DocumenterCitations` for bibliography

Author: schillic

docs/Project.toml

@@ -1,7 +1,9 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 LazySets = "b4f0291d-fe17-52bc-9479-3d1a343d9043"
 
 [compat]
 Documenter = "1"
+DocumenterCitations = "1.3"
 LazySets = "2, 3"

docs/make.jl

@@ -1,19 +1,24 @@
-using Documenter, MathematicalSystems
+using Documenter, MathematicalSystems, DocumenterCitations
 import LazySets
 
 DocMeta.setdocmeta!(MathematicalSystems, :DocTestSetup,
                     :(using MathematicalSystems); recursive=true)
 
+bib = CitationBibliography(joinpath(@__DIR__, "src", "refs.bib"); style=:alpha)
+
 makedocs(; sitename="MathematicalSystems.jl",
          modules=[MathematicalSystems],
          format=Documenter.HTML(; prettyurls=get(ENV, "CI", nothing) == "true",
-                                assets=["assets/aligned.css"], size_threshold_warn=150 * 2^10),
+                                assets=["assets/aligned.css", "assets/citations.css"],
+                                size_threshold_warn=150 * 2^10),
          pagesonly=true,
+         plugins=[bib],
          pages=["Home" => "index.md",
                 "Manual" => Any["Overview of System Types" => "man/systems.md"],
                 "Library" => Any["Types"     => "lib/types.md",
                                  "Methods"   => "lib/methods.md",
                                  "Internals" => "lib/internals.md"],
+                "Bibliography" => "bibliography.md",
                 "About" => "about.md"])
 
 deploydocs(; repo="github.com/JuliaReach/MathematicalSystems.jl.git",

docs/src/assets/citations.css

@@ -0,0 +1,17 @@
+.citation dl {
+  display: grid;
+  grid-template-columns: max-content auto; }
+.citation dt {
+  grid-column-start: 1; }
+.citation dd {
+  grid-column-start: 2;
+  margin-bottom: 0.75em; }
+.citation ul {
+ padding: 0 0 2.25em 0;
+ margin: 0;
+ list-style: none !important;}
+.citation ul li {
+ text-indent: -2.25em;
+ margin: 0.33em 0.5em 0.5em 2.25em;}
+.citation ol li {
+ padding-left:0.75em;}

docs/src/bibliography.md

@@ -0,0 +1,4 @@
+# Bibliography
+
+```@bibliography
+```

docs/src/refs.bib

@@ -0,0 +1,7 @@
+@book{Sontag13,
+  title={Mathematical control theory: deterministic finite dimensional systems},
+  author={Sontag, Eduardo D},
+  volume={6},
+  year={2013},
+  publisher={Springer Science \& Business Media}
+}

src/abstract.jl

@@ -129,7 +129,7 @@ Determines whether the dynamics of system `s` is specified by linear equations.
 
 ### Notes
 
-We adopt the notion from [Section 2.7, 1]. For example, the system with inputs
+We adopt the notion from [Sontag13; Section 2.7](@citet). For example, the system with inputs
 ``x' = f(t, x, u) = A x + B u`` is linear, since the function ``f(t, ⋅, ⋅)`` is
 linear in ``(x, u)`` for each ``t ∈ \\mathbb{R}``. On the other hand,
 ``x' = f(t, x, u) = A x + B u + c`` is affine but not linear, since it is not
@@ -139,9 +139,6 @@ The result of this function only depends on the system type, not the value, and
 can also be applied to `typeof(s)`. So, if a system type allows an instance that
 is not linear, it returns `false` by default. For example, polynomial systems
 can be nonlinear; hence `islinear` returns `false`.
-
-[1] Sontag, Eduardo D. *Mathematical control theory: deterministic finite dimensional
-systems.* Vol. 6. Springer Science & Business Media, 2013.
 """
 function islinear(::AbstractSystem) end