Merge pull request #220 from ArnoStrouwen/docs1

Documenter 1.0 upgrade
SciML · Sep 23, 2023 · d1e0762 · d1e0762
2 parents b9b18ed + 55ba281
commit d1e0762
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 35 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
@@ -12,7 +12,7 @@ Sundials = "c3572dad-4567-51f8-b174-8c6c989267f4"
 
 [compat]
 BenchmarkTools = "1"
-Documenter = "0.27"
+Documenter = "1"
 LinearSolve = "2"
 NonlinearSolve = "1, 2"
 NonlinearSolveMINPACK = "0.1"

diff --git a/docs/make.jl b/docs/make.jl
@@ -11,15 +11,9 @@ makedocs(sitename = "NonlinearSolve.jl",
     modules = [NonlinearSolve, NonlinearSolve.SciMLBase, NonlinearSolve.DiffEqBase,
         SimpleNonlinearSolve, Sundials, SciMLNLSolve, NonlinearSolveMINPACK,
         SteadyStateDiffEq],
-    clean = true, doctest = false,
-    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, linkcheck = true,
+    linkcheck_ignore = ["https://twitter.com/ChrisRackauckas/status/1544743542094020615"],
+    warnonly = [:missing_docs, :cross_references],
     format = Documenter.HTML(assets = ["assets/favicon.ico"],
         canonical = "https://docs.sciml.ai/NonlinearSolve/stable/"),
     pages = pages)

diff --git a/docs/src/basics/TerminationCondition.md b/docs/src/basics/TerminationCondition.md
@@ -1,6 +1,6 @@
 # Termination Conditions
 
-Provides a API to specify termination conditions for [`NonLinearProblem`](@ref) and
+Provides a API to specify termination conditions for [`NonlinearProblem`](@ref) and
 [`SteadyStateProblem`](@ref). For details on the various termination modes, i.e.,
 NLSolveTerminationMode, see the documentation for [`NLSolveTerminationCondition`](@ref).
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -82,32 +82,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.
+""")
 ```