Skip to content

Commit cedbc3b

Browse files
committed
Documenter 1.0 upgrade
1 parent 21f757a commit cedbc3b

File tree

4 files changed

+19
-34
lines changed

4 files changed

+19
-34
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
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}

docs/Project.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
88
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
99
MosekTools = "1ec41992-ff65-5c91-ac43-2df89e9693a4"
1010
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
11+
PolyChaos = "8d666b04-775d-5f6e-b778-5ac7c70f65a3"
1112
QuadGK = "1fd47b50-473d-5c70-9696-f719f8f3bcdc"
1213
SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
1314

1415
[compat]
1516
AbstractTrees = "0.3, 0.4"
1617
DifferentialEquations = "6.15, 7"
17-
Documenter = "0.27"
18+
Documenter = "1"
1819
GR = "0.46, 0.72"
1920
JuMP = "0.2, 1"
2021
LaTeXStrings = "1.0"

docs/make.jl

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,8 @@ makedocs(sitename = "PolyChaos.jl",
1212
linkcheck_ignore = [
1313
"https://www.sciencedirect.com/science/article/pii/S235246771830105X",
1414
],
15-
strict = [
16-
:doctest,
17-
:linkcheck,
18-
:parse_error,
19-
# Other available options are
20-
# :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
21-
],
22-
format = Documenter.HTML(analytics = "UA-90474609-3",
23-
assets = ["assets/favicon.ico"],
15+
warnonly = [:setup_block, :missing_docs, :example_block],
16+
format = Documenter.HTML(assets = ["assets/favicon.ico"],
2417
canonical = "https://docs.sciml.ai/PolyChaos/stable/"),
2518
modules = [PolyChaos],
2619
authors = "tillmann.muehlpfordt@kit.edu",

docs/src/index.md

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

177-
```@raw html
178-
You can also download the
179-
<a href="
180-
```
181-
182177
```@eval
183178
using TOML
179+
using Markdown
184180
version = TOML.parse(read("../../Project.toml", String))["version"]
185181
name = TOML.parse(read("../../Project.toml", String))["name"]
186-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
187-
"/assets/Manifest.toml"
188-
```
189-
190-
```@raw html
191-
">manifest</a> file and the
192-
<a href="
193-
```
194-
195-
```@eval
196-
using TOML
197-
version = TOML.parse(read("../../Project.toml", String))["version"]
198-
name = TOML.parse(read("../../Project.toml", String))["name"]
199-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
200-
"/assets/Project.toml"
201-
```
202-
203-
```@raw html
204-
">project</a> file.
182+
link_manifest = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
183+
"/assets/Manifest.toml"
184+
link_project = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
185+
"/assets/Project.toml"
186+
Markdown.parse("""You can also download the
187+
[manifest]($link_manifest)
188+
file and the
189+
[project]($link_project)
190+
file.
191+
""")
205192
```

0 commit comments

Comments
 (0)