Documenter 1.0 upgrade

Author: ArnoStrouwen

.github/workflows/CI.yml

@@ -3,9 +3,13 @@ on:
   pull_request:
     branches:
       - main
+    paths-ignore:
+      - 'docs/**'
   push:
     branches:
       - main
+    paths-ignore:
+      - 'docs/**'
 jobs:
   test:
     runs-on: ubuntu-latest

.github/workflows/FormatCheck.yml

@@ -3,7 +3,7 @@ name: format-check
 on:
   push:
     branches:
-      - 'master'
+      - 'main'
       - 'release-'
     tags: '*'
   pull_request:

docs/Project.toml

@@ -11,9 +11,8 @@ Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 [compat]
 ControlSystemsBase = "1.1"
 DifferentialEquations = "7.6"
-Documenter = "0.27"
+Documenter = "1"
 IfElse = "0.1"
 ModelingToolkit = "8.67"
-ModelingToolkitStandardLibrary = "2"
 OrdinaryDiffEq = "6.31"
 Plots = "1.36"

docs/make.jl

@@ -19,14 +19,6 @@ include("pages.jl")
 
 makedocs(sitename = "ModelingToolkitStandardLibrary.jl",
     authors = "Julia Computing",
-    clean = true,
-    doctest = false,
-    linkcheck = true,
-    strict = [
-        :linkcheck,
-        :doctest,
-        :example_block,
-    ],
     modules = [ModelingToolkit,
         ModelingToolkitStandardLibrary,
         ModelingToolkitStandardLibrary.Blocks,
@@ -38,6 +30,8 @@ makedocs(sitename = "ModelingToolkitStandardLibrary.jl",
         ModelingToolkitStandardLibrary.Thermal,
         ModelingToolkitStandardLibrary.Hydraulic,
         ModelingToolkitStandardLibrary.Hydraulic.IsothermalCompressible],
+    clean = true, doctest = false, linkcheck = true,
+    warnonly = [:docs_block, :missing_docs, :cross_references],
     format = Documenter.HTML(assets = ["assets/favicon.ico"],
         canonical = "https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/"),
     pages = pages)

docs/src/index.md

@@ -87,32 +87,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.
+""")
 ```