build PDF documentation

Author: sumiya11

docs/.gitignore

@@ -1,3 +1,3 @@
-__site/
-site/
-build/
+build
+latex_build
+Groebner.jl.pdf

docs/make.jl

@@ -1,21 +1,56 @@
+# Adapted from JUMP. The license is MPL version 2.0.
+
 using Groebner
 using Documenter
 
-makedocs(
-    modules = [Groebner],
-    sitename = "Groebner.jl",
-    doctest = true,
+# Setup
+
+const _IS_GITHUB_ACTIONS = get(ENV, "GITHUB_ACTIONS", "false") == "true"
+
+latex_platform = _IS_GITHUB_ACTIONS ? "docker" : "native"
+
+# Documentation structure
+
+PAGES = [
+    "Home"      => "index.md", 
+    "Examples"  => "examples.md", 
+    "Interface" => "interface.md"
+]
+
+# Build the HTML documentation
+
+# Needed to make Documenter think that there is a PDF in the right place when
+# link checking. Inn production we replace this by running the LaTeX build.
+write(joinpath(@__DIR__, "src", "Groebner.jl.pdf"), "")
+
+@time Documenter.makedocs(
+    modules   = [Groebner],
+    sitename  = "Groebner.jl",
+    doctest   = true,
     linkcheck = true,
     checkdocs = :exports,
-    warnonly=true,
-    pages = [
-        "Home" => "index.md",
-        "Examples" => "examples.md",
-        "Interface" => "interface.md",
-    ],
+    warnonly  = true,
+    pages     = PAGES
+)
+
+# Build the PDF documentation
+
+@time Documenter.makedocs(
+    sitename = "Groebner.jl",
+    authors  = "The Groebner.jl developers and contributors",
+    format   = Documenter.LaTeX(; platform=latex_platform),
+    build    = "latex_build",
+    pages    = PAGES,
+    debug    = true
+)
+cp(
+    joinpath(@__DIR__, "latex_build", "Groebner.jl.pdf"),
+    joinpath(@__DIR__, "build", "Groebner.jl.pdf");
+    force=true
 )
 
+# Deploy build/
 
 deploydocs(
-    repo   = "github.com/sumiya11/Groebner.jl.git"
+    repo="github.com/sumiya11/Groebner.jl.git"
 )

docs/src/examples.md

@@ -92,7 +92,7 @@ For other ground fields, a possibly slower generic fallback is used. In this cas
 
 For example, we can compute a Gröbner basis over a univariate rational function field over a finite field:
 
-```@example generic-2
+```@example generic2
 using Groebner, AbstractAlgebra
 
 R, t = GF(101)["t"]
@@ -106,7 +106,7 @@ gb = groebner(sys)
 
 Many functions reuse the core implementation, so they can also be used over generic fields:
 
-```@example generic-2
+```julia
 @assert isgroebner(gb)
 normalform(gb, x*y)
 ```

docs/src/index.md

@@ -2,6 +2,10 @@
 
 Groebner.jl is a package for computing Gröbner bases written in Julia.
 
+!!! note
+
+      This documentation is also available in PDF format: [Groebner.jl.pdf](Groebner.jl.pdf).
+
 ## Installation
 
 To install Groebner.jl, run the following in the Julia REPL:

docs/src/interface.md

@@ -4,7 +4,7 @@
 CurrentModule = Groebner
 ```
 
-## Exported functions
+## Main functions
 
 ```@docs
 groebner