From 8da0a374df09dd2191eaa7d516a345d810be8bbe Mon Sep 17 00:00:00 2001 From: Arno Strouwen Date: Sat, 23 Sep 2023 02:36:56 +0200 Subject: [PATCH] upgrade Documenter 1.0 --- .github/workflows/CI.yml | 4 ++++ docs/Project.toml | 2 +- docs/make.jl | 14 +++----------- docs/src/index.md | 35 +++++++++++------------------------ 4 files changed, 19 insertions(+), 36 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index d92413c1..39a0b5ff 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 3fd26569..79a844e4 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -10,7 +10,7 @@ Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f" [compat] Distributions = "0.25" -Documenter = "0.27" +Documenter = "1" FiniteDiff = "2" ForwardDiff = "0.10" Integrals = "3" diff --git a/docs/make.jl b/docs/make.jl index a63fbdcc..c1cb1224 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -8,17 +8,9 @@ include("pages.jl") makedocs(sitename = "Integrals.jl", authors = "Chris Rackauckas", modules = [Integrals, Integrals.SciMLBase], - 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 - ], - format = Documenter.HTML(analytics = "UA-90474609-3", - assets = ["assets/favicon.ico"], + clean = true, doctest = false, linkcheck = true, + warnonly = [:missing_docs], + format = Documenter.HTML(assets = ["assets/favicon.ico"], canonical = "https://docs.sciml.ai/Integrals/stable/"), pages = pages) diff --git a/docs/src/index.md b/docs/src/index.md index 630035b8..ccd9265c 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -71,32 +71,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. +""") ```