Merge pull request #285 from ArnoStrouwen/docs1

Documenter 1.0 upgrade
SciML · Sep 25, 2023 · 0965fc1 · 0965fc1
2 parents a672983 + 31154f1
commit 0965fc1
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 36 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
@@ -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
@@ -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
@@ -72,32 +72,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.
+""")
 ```
diff --git 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