From f1e4530d7aae6ef0d60b797e50c2742f5fbe301a Mon Sep 17 00:00:00 2001 From: Arno Strouwen Date: Mon, 25 Sep 2023 06:38:49 +0200 Subject: [PATCH 1/2] Documenter 1.0 upgrade --- .github/workflows/CI.yml | 4 ++++ docs/Project.toml | 2 +- docs/make.jl | 12 ++---------- docs/src/index.md | 35 +++++++++++------------------------ 4 files changed, 18 insertions(+), 35 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 077d0790..b56df0cf 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 92429a33..ffab08e9 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -3,5 +3,5 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" RecursiveArrayTools = "731186ca-8d62-57ce-b412-fbd966d074cd" [compat] -Documenter = "0.27" +Documenter = "1" RecursiveArrayTools = "2.32" diff --git a/docs/make.jl b/docs/make.jl index 0e3883f7..eb6f13df 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -9,16 +9,8 @@ makedocs(sitename = "RecursiveArrayTools.jl", authors = "Chris Rackauckas", modules = [RecursiveArrayTools], clean = true, doctest = false, linkcheck = true, - 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"], + warnonly = [:missing_docs], + format = Documenter.HTML(assets = ["assets/favicon.ico"], canonical = "https://docs.sciml.ai/RecursiveArrayTools/stable/"), pages = pages) diff --git a/docs/src/index.md b/docs/src/index.md index 79403ef7..777b696e 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -72,32 +72,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. +""") ``` From 31154f171252b5fd3471c07a0328a044d2d13b4e Mon Sep 17 00:00:00 2001 From: Arno Strouwen Date: Mon, 25 Sep 2023 06:42:14 +0200 Subject: [PATCH 2/2] LanguageTool --- src/vector_of_array.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/vector_of_array.jl b/src/vector_of_array.jl index fa21fc04..47a4cf6b 100644 --- a/src/vector_of_array.jl +++ b/src/vector_of_array.jl @@ -7,7 +7,7 @@ VectorOfArray(u::AbstractVector) A `VectorOfArray` is an array which has the underlying data structure `Vector{AbstractArray{T}}` (but, hopefully, concretely typed!). This wrapper over such data structures allows one to lazily -act like it's a higher-dimensional vector, and easily convert to different forms. The indexing +act like it's a higher-dimensional vector, and easily convert it to different forms. The indexing structure is: ```julia