Skip to content

Commit 974a36f

Browse files
committed
Finish Documenter 1.0 upgrade
1 parent 74e04a0 commit 974a36f

File tree

3 files changed

+16
-24
lines changed

3 files changed

+16
-24
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
- main
6+
paths-ignore:
7+
- 'docs/**'
68
push:
79
branches:
810
- main
11+
paths-ignore:
12+
- 'docs/**'
913
jobs:
1014
test:
1115
runs-on: ubuntu-latest

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ makedocs(sitename = "LinearSolve.jl",
1212
authors = "Chris Rackauckas",
1313
modules = [LinearSolve, LinearSolve.SciMLBase],
1414
clean = true, doctest = false, linkcheck = true,
15+
warnonly = [:docs_block, :missing_docs],
1516
format = Documenter.HTML(assets = ["assets/favicon.ico"],
1617
canonical = "https://docs.sciml.ai/LinearSolve/stable/"),
1718
pages = pages)

docs/src/index.md

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

87-
```@raw html
88-
You can also download the
89-
<a href="
90-
```
91-
9287
```@eval
9388
using TOML
89+
using Markdown
9490
version = TOML.parse(read("../../Project.toml", String))["version"]
9591
name = TOML.parse(read("../../Project.toml", String))["name"]
96-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
97-
"/assets/Manifest.toml"
98-
```
99-
100-
```@raw html
101-
">manifest</a> file and the
102-
<a href="
103-
```
104-
105-
```@eval
106-
using TOML
107-
version = TOML.parse(read("../../Project.toml", String))["version"]
108-
name = TOML.parse(read("../../Project.toml", String))["name"]
109-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
110-
"/assets/Project.toml"
111-
```
112-
113-
```@raw html
114-
">project</a> file.
92+
link_manifest = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
93+
"/assets/Manifest.toml"
94+
link_project = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
95+
"/assets/Project.toml"
96+
Markdown.parse("""You can also download the
97+
[manifest]($link_manifest)
98+
file and the
99+
[project]($link_project)
100+
file.
101+
""")
115102
```

0 commit comments

Comments
 (0)