From 7383982e52e4fc8686cc1050fc81a5c175e80b83 Mon Sep 17 00:00:00 2001 From: Arno Strouwen Date: Tue, 26 Sep 2023 00:52:41 +0200 Subject: [PATCH] Documenter 1.0 upgrade --- .github/workflows/CI.yml | 4 ++++ .github/workflows/FormatCheck.yml | 2 +- docs/Project.toml | 3 +-- docs/make.jl | 10 ++------- docs/src/index.md | 35 ++++++++++--------------------- 5 files changed, 19 insertions(+), 35 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 023acbf5e..48a0f9232 100644 --- a/.github/workflows/CI.yml +++ b/.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 diff --git a/.github/workflows/FormatCheck.yml b/.github/workflows/FormatCheck.yml index dd551501c..45bd09c47 100644 --- a/.github/workflows/FormatCheck.yml +++ b/.github/workflows/FormatCheck.yml @@ -3,7 +3,7 @@ name: format-check on: push: branches: - - 'master' + - 'main' - 'release-' tags: '*' pull_request: diff --git a/docs/Project.toml b/docs/Project.toml index e38c82671..034ba981d 100644 --- a/docs/Project.toml +++ b/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" diff --git a/docs/make.jl b/docs/make.jl index ed1072c80..3a6e05ec8 100644 --- a/docs/make.jl +++ b/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) diff --git a/docs/src/index.md b/docs/src/index.md index 90aed9b00..e6e05c0c4 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -87,32 +87,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. +""") ```