Skip to content

Commit f1e4530

Browse files
committed
Documenter 1.0 upgrade
1 parent a672983 commit f1e4530

File tree

4 files changed

+18
-35
lines changed

4 files changed

+18
-35
lines changed

.github/workflows/CI.yml

+4
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,13 @@ on:
33
pull_request:
44
branches:
55
- master
6+
paths-ignore:
7+
- 'docs/**'
68
push:
79
branches:
810
- master
11+
paths-ignore:
12+
- 'docs/**'
913
jobs:
1014
test:
1115
runs-on: ubuntu-latest

docs/Project.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
33
RecursiveArrayTools = "731186ca-8d62-57ce-b412-fbd966d074cd"
44

55
[compat]
6-
Documenter = "0.27"
6+
Documenter = "1"
77
RecursiveArrayTools = "2.32"

docs/make.jl

+2-10
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,8 @@ makedocs(sitename = "RecursiveArrayTools.jl",
99
authors = "Chris Rackauckas",
1010
modules = [RecursiveArrayTools],
1111
clean = true, doctest = false, linkcheck = true,
12-
strict = [
13-
:doctest,
14-
:linkcheck,
15-
:parse_error,
16-
:example_block,
17-
# Other available options are
18-
# :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
19-
],
20-
format = Documenter.HTML(analytics = "UA-90474609-3",
21-
assets = ["assets/favicon.ico"],
12+
warnonly = [:missing_docs],
13+
format = Documenter.HTML(assets = ["assets/favicon.ico"],
2214
canonical = "https://docs.sciml.ai/RecursiveArrayTools/stable/"),
2315
pages = pages)
2416

docs/src/index.md

+11-24
Original file line numberDiff line numberDiff line change
@@ -72,32 +72,19 @@ Pkg.status(; mode = PKGMODE_MANIFEST) # hide
7272
</details>
7373
```
7474

75-
```@raw html
76-
You can also download the
77-
<a href="
78-
```
79-
8075
```@eval
8176
using TOML
77+
using Markdown
8278
version = TOML.parse(read("../../Project.toml", String))["version"]
8379
name = TOML.parse(read("../../Project.toml", String))["name"]
84-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
85-
"/assets/Manifest.toml"
86-
```
87-
88-
```@raw html
89-
">manifest</a> file and the
90-
<a href="
91-
```
92-
93-
```@eval
94-
using TOML
95-
version = TOML.parse(read("../../Project.toml", String))["version"]
96-
name = TOML.parse(read("../../Project.toml", String))["name"]
97-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
98-
"/assets/Project.toml"
99-
```
100-
101-
```@raw html
102-
">project</a> file.
80+
link_manifest = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
81+
"/assets/Manifest.toml"
82+
link_project = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
83+
"/assets/Project.toml"
84+
Markdown.parse("""You can also download the
85+
[manifest]($link_manifest)
86+
file and the
87+
[project]($link_project)
88+
file.
89+
""")
10390
```

0 commit comments

Comments
 (0)