Skip to content

Commit f604f45

Browse files
committed
Documenter 1.0 upgrade
1 parent 873db37 commit f604f45

File tree

4 files changed

+19
-36
lines changed

4 files changed

+19
-36
lines changed

.github/workflows/CI.yml

Lines changed: 4 additions & 0 deletions
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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ MultiScaleArrays = "f9640e96-87f6-5992-9c3b-0743c6a49ffa"
33
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
44

55
[compat]
6-
Documenter = "0.27"
6+
Documenter = "1"
77
MultiScaleArrays = "1.10"

docs/make.jl

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,8 @@ makedocs(sitename = "MultiScaleArrays.jl",
99
authors = "Chris Rackauckas",
1010
modules = [MultiScaleArrays],
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/MultiScaleArrays/stable/"),
2315
pages = pages)
2416

docs/src/index.md

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -150,32 +150,19 @@ Pkg.status(; mode = PKGMODE_MANIFEST) # hide
150150
</details>
151151
```
152152

153-
```@raw html
154-
You can also download the
155-
<a href="
156-
```
157-
158-
```@eval
159-
using TOML
160-
version = TOML.parse(read("../../Project.toml", String))["version"]
161-
name = TOML.parse(read("../../Project.toml", String))["name"]
162-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
163-
"/assets/Manifest.toml"
164-
```
165-
166-
```@raw html
167-
">manifest</a> file and the
168-
<a href="
169-
```
170-
171153
```@eval
172154
using TOML
155+
using Markdown
173156
version = TOML.parse(read("../../Project.toml", String))["version"]
174157
name = TOML.parse(read("../../Project.toml", String))["name"]
175-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
176-
"/assets/Project.toml"
177-
```
178-
179-
```@raw html
180-
">project</a> file.
181-
```
158+
link_manifest = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
159+
"/assets/Manifest.toml"
160+
link_project = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
161+
"/assets/Project.toml"
162+
Markdown.parse("""You can also download the
163+
[manifest]($link_manifest)
164+
file and the
165+
[project]($link_project)
166+
file.
167+
""")
168+
```

0 commit comments

Comments
 (0)