Merge pull request #516 from ArnoStrouwen/docs1

Documenter 1.0 upgrade
SciML · Sep 30, 2023 · 16db0e3 · 16db0e3
2 parents af2529c + 29ec55e
commit 16db0e3
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 27 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -3,9 +3,13 @@ on:
   pull_request:
     branches:
       - master
+    paths-ignore:
+      - 'docs/**'
   push:
     branches:
       - master
+    paths-ignore:
+      - 'docs/**'
 jobs:
   test:
     runs-on: ubuntu-latest

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -4,6 +4,6 @@ ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
 SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 
 [compat]
-Documenter = "0.27"
+Documenter = "1"
 ModelingToolkit = "8.35"
 SciMLBase = "1.74, 2"
diff --git a/docs/make.jl b/docs/make.jl
@@ -8,9 +8,9 @@ include("pages.jl")
 makedocs(sitename = "SciMLBase.jl",
     authors = "Chris Rackauckas",
     modules = [SciMLBase, ModelingToolkit],
-    clean = true, doctest = false,
-    format = Documenter.HTML(analytics = "UA-90474609-3",
-        assets = ["assets/favicon.ico"],
+    clean = true, doctest = false, linkcheck = true,
+    warnonly = [:docs_block, :missing_docs],
+    format = Documenter.HTML(assets = ["assets/favicon.ico"],
         canonical = "https://docs.sciml.ai/SciMLBase/stable"),
     pages = pages)
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -220,26 +220,19 @@ Pkg.status(;mode = PKGMODE_MANIFEST) # hide
 ```@raw html
 </details>
 ```
-```@raw html
-You can also download 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/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.
-```
+using Markdown
+version = TOML.parse(read("../../Project.toml", String))["version"]
+name = TOML.parse(read("../../Project.toml", String))["name"]
+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.
+""")
+```
diff --git a/docs/src/interfaces/SciMLFunctions.md b/docs/src/interfaces/SciMLFunctions.md
@@ -84,9 +84,9 @@ there's no worry of aliasing.
 
 In general the jacobian prototype can be anything that has `mul!` defined, in
 particular sparse matrices or custom lazy types that support `mul!`. A special case
-is when the `jac_prototype` is a `AbstractDiffEqLinearOperator`, in which case you
+is when the `jac_prototype` is a `AbstractSciMLOperator`, in which case you
 do not need to supply `jac` as it is automatically set to `update_coefficients!`.
-Refer to the [DiffEqOperators](@ref) section for more information
+Refer to the [SciMLOperators](https://docs.sciml.ai/SciMLOperators/stable/premade_operators/) section for more information
 on setting up time/parameter dependent operators.
 
 ### Sparsity Handling