Merge pull request #2267 from ArnoStrouwen/docs1.0

docs 1.0 upgrade
SciML · Sep 17, 2023 · 34c336b · 34c336b
2 parents 370e7ac + ce257ed
commit 34c336b
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 13 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -21,7 +21,7 @@ Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 BenchmarkTools = "1.3"
 DifferentialEquations = "7.6"
 Distributions = "0.25"
-Documenter = "0.27, 1"
+Documenter = "1"
 ModelingToolkit = "8.33"
 NonlinearSolve = "0.3, 1"
 Optim = "1.7"

diff --git a/docs/make.jl b/docs/make.jl
@@ -23,15 +23,8 @@ makedocs(sitename = "ModelingToolkit.jl",
     authors = "Chris Rackauckas",
     modules = [ModelingToolkit],
     clean = true, doctest = false, linkcheck = true,
+    warnonly = [:docs_block, :missing_docs, :cross_references],
     linkcheck_ignore = ["https://epubs.siam.org/doi/10.1137/0903023"],
-    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
-    ],
     format = Documenter.HTML(; analytics = "UA-90474609-3",
         assets = ["assets/favicon.ico"],
         mathengine,

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -230,10 +230,11 @@ You can also download the
 
 ```@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"
+link = Markdown.MD("https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
+                   "/assets/Manifest.toml")
 ```
 
 ```@raw html
@@ -243,10 +244,11 @@ link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
 
 ```@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/Project.toml"
+link = Markdown.MD("https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
+                   "/assets/Project.toml")
 ```
 
 ```@raw html