Skip to content

Commit 8e4807e

Browse files
committed
Documenter 1.0 upgrade
1 parent 368e9b6 commit 8e4807e

File tree

4 files changed

+18
-35
lines changed

4 files changed

+18
-35
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
@@ -11,7 +11,7 @@ StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
1111

1212
[compat]
1313
DataDrivenDiffEq = "1"
14-
Documenter = "0.27"
14+
Documenter = "1"
1515
Literate = "2.14"
1616
ModelingToolkit = "8"
1717
OrdinaryDiffEq = "6"

docs/make.jl

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,11 @@ makedocs(sitename = "DataDrivenDiffEq.jl",
7272
authors = "Julius Martensen, Christopher Rackauckas, et al.",
7373
modules = [DataDrivenDiffEq, DataDrivenDMD, DataDrivenSparse, DataDrivenSR],
7474
clean = true, doctest = false, linkcheck = true,
75+
warnonly = [:missing_docs, :cross_references],
7576
linkcheck_ignore = ["http://cwrowley.princeton.edu/papers/Hemati-2017a.pdf",
7677
"https://royalsocietypublishing.org/doi/10.1098/rspa.2020.0279",
7778
"https://www.pnas.org/doi/10.1073/pnas.1517384113"],
78-
strict = [
79-
:doctest,
80-
:linkcheck,
81-
:parse_error,
82-
:example_block,
83-
# Other available options are
84-
# :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
85-
],
86-
format = Documenter.HTML(analytics = "UA-90474609-3",
87-
assets = ["assets/favicon.ico"],
79+
format = Documenter.HTML(assets = ["assets/favicon.ico"],
8880
canonical = "https://docs.sciml.ai/DataDrivenDiffEq/stable/"),
8981
pages = pages)
9082

docs/src/index.md

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

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

0 commit comments

Comments
 (0)