From 55ba28144e5ec0ecaccc912a22a2053107f3aa7f Mon Sep 17 00:00:00 2001 From: Arno Strouwen Date: Sat, 23 Sep 2023 03:34:49 +0200 Subject: [PATCH] Documenter 1.0 upgrade --- .github/workflows/CI.yml | 4 +++ docs/Project.toml | 2 +- docs/make.jl | 12 +++------ docs/src/basics/TerminationCondition.md | 2 +- docs/src/index.md | 35 ++++++++----------------- 5 files changed, 20 insertions(+), 35 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 75f12a2e9..e0d7a57e5 100644 --- 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 index df765bb1d..42e261955 100644 --- 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 index d2815c502..8f895b0b4 100644 --- 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 index cd780b997..e966bb22c 100644 --- 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 index c47fb57de..3d7e97890 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -82,32 +82,19 @@ Pkg.status(; mode = PKGMODE_MANIFEST) # hide ``` -```@raw html -You can also download the -manifest file and the -project 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. +""") ```