CompatHelper: bump compat for Documenter to 1 for package docs, (keep…

… existing compat) (#1641) * CompatHelper: bump compat for Documenter to 1 for package docs, (keep existing compat) * remove strict since it is removed and active by default * allow only v1 of Documenter.jl * ignore size threshold for API reference of Trixi.jl * try to fix size_threshold_ignore --------- Co-authored-by: CompatHelper Julia <[email protected]> Co-authored-by: Hendrik Ranocha <[email protected]> Co-authored-by: Hendrik Ranocha <[email protected]>
trixi-framework · Sep 19, 2023 · a64004d · a64004d
1 parent 73384ac
commit a64004d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -13,7 +13,7 @@ Trixi2Vtk = "bc1476a1-1ca6-4cc3-950b-c312b255ff95"
 
 [compat]
 CairoMakie = "0.6, 0.7, 0.8, 0.9, 0.10"
-Documenter = "0.27"
+Documenter = "1"
 ForwardDiff = "0.10"
 HOHQMesh = "0.1, 0.2"
 LaTeXStrings = "1.2"

diff --git a/docs/make.jl b/docs/make.jl
@@ -77,15 +77,16 @@ makedocs(
     # Specify modules for which docstrings should be shown
     modules = [Trixi, Trixi2Vtk],
     # Set sitename to Trixi.jl
-    sitename="Trixi.jl",
+    sitename = "Trixi.jl",
     # Provide additional formatting options
     format = Documenter.HTML(
         # Disable pretty URLs during manual testing
         prettyurls = get(ENV, "CI", nothing) == "true",
         # Explicitly add favicon as asset
         assets = ["assets/favicon.ico"],
         # Set canonical URL to GitHub pages URL
-        canonical = "https://trixi-framework.github.io/Trixi.jl/stable"
+        canonical = "https://trixi-framework.github.io/Trixi.jl/stable",
+        size_threshold_ignore = ["reference-trixi.md"]
     ),
     # Explicitly specify documentation structure
     pages = [
@@ -124,9 +125,8 @@ makedocs(
         "Authors" => "authors.md",
         "Contributing" => "contributing.md",
         "Code of Conduct" => "code_of_conduct.md",
-        "License" => "license.md"
-    ],
-    strict = true # to make the GitHub action fail when doctests fail, see https://github.com/neuropsychology/Psycho.jl/issues/34
+        "License" => "license.md",
+    ]
 )
 
 deploydocs(