Merge pull request #301 from ArnoStrouwen/docs1

Documenter 1.0 upgrade
SciML · Sep 25, 2023 · eab893b · eab893b
2 parents 86acb3f + 123000e
commit eab893b
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 36 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -24,7 +24,7 @@ BenchmarkTools = "1"
 CUDA = "4, 5"
 DiffEqBase = "6.120"
 DiffEqGPU = "1,2"
-Documenter = "0.27"
+Documenter = "1"
 Flux = "0.13, 0.14"
 ForwardDiff = "0.10"
 OrdinaryDiffEq = "6"

diff --git a/docs/make.jl b/docs/make.jl
@@ -8,17 +8,9 @@ cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
 makedocs(sitename = "DiffEqGPU.jl",
     authors = "Chris Rackauckas",
     modules = [DiffEqGPU],
-    strict = [
-        :doctest,
-        :linkcheck,
-        :parse_error,
-        :example_block,
-        # Other available options are
-        # :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
-    ],
-    clean = true, doctest = false,
-    format = Documenter.HTML(analytics = "UA-90474609-3",
-        assets = ["assets/favicon.ico"],
+    clean = true, doctest = false, linkcheck = true,
+    warnonly = [:missing_docs],
+    format = Documenter.HTML(assets = ["assets/favicon.ico"],
         canonical = "https://docs.sciml.ai/DiffEqGPU/stable/"),
     pages = pages)
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -73,32 +73,19 @@ Pkg.status(; mode = PKGMODE_MANIFEST) # hide
 </details>
 ```
 
-```@raw html
-You can also download the
-<a href="
-```
-
 ```@eval
 using TOML
+using Markdown
 version = TOML.parse(read("../../Project.toml", String))["version"]
 name = TOML.parse(read("../../Project.toml", String))["name"]
-link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
-       "/assets/Manifest.toml"
-```
-
-```@raw html
-">manifest</a> file and the
-<a href="
-```
-
-```@eval
-using TOML
-version = TOML.parse(read("../../Project.toml", String))["version"]
-name = TOML.parse(read("../../Project.toml", String))["name"]
-link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
-       "/assets/Project.toml"
-```
-
-```@raw html
-">project</a> file.
+link_manifest = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
+                "/assets/Manifest.toml"
+link_project = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
+               "/assets/Project.toml"
+Markdown.parse("""You can also download the
+[manifest]($link_manifest)
+file and the
+[project]($link_project)
+file.
+""")
 ```