Skip to content

Commit 3d9362a

Browse files
Merge pull request #77 from ArnoStrouwen/docs1.0
Documenter 1.0 upgrade
2 parents d889499 + 259bd83 commit 3d9362a

File tree

4 files changed

+16
-34
lines changed

4 files changed

+16
-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
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 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
33
PreallocationTools = "d236fae5-4411-538c-8e31-a6e3d9e00b46"
44

55
[compat]
6-
Documenter = "0.27"
6+
Documenter = "1"
77
PreallocationTools = "0.4"

docs/make.jl

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,6 @@ makedocs(sitename = "PreallocationTools.jl",
99
authors = "Chris Rackauckas",
1010
modules = [PreallocationTools],
1111
clean = true, doctest = false, linkcheck = true,
12-
strict = [
13-
:doctest,
14-
:linkcheck,
15-
:parse_error,
16-
:example_block,
17-
:cross_references,
18-
# Other available options are
19-
# :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
20-
],
2112
format = Documenter.HTML(assets = ["assets/favicon.ico"],
2213
canonical = "https://docs.sciml.ai/PreallocationTools/stable/"),
2314
pages = pages)

docs/src/index.md

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

371-
```@raw html
372-
You can also download the
373-
<a href="
374-
```
375-
376371
```@eval
377372
using TOML
373+
using Markdown
378374
version = TOML.parse(read("../../Project.toml", String))["version"]
379375
name = TOML.parse(read("../../Project.toml", String))["name"]
380-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
381-
"/assets/Manifest.toml"
382-
```
383-
384-
```@raw html
385-
">manifest</a> file and the
386-
<a href="
387-
```
388-
389-
```@eval
390-
using TOML
391-
version = TOML.parse(read("../../Project.toml", String))["version"]
392-
name = TOML.parse(read("../../Project.toml", String))["name"]
393-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
394-
"/assets/Project.toml"
395-
```
396-
397-
```@raw html
398-
">project</a> file.
376+
link_manifest = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
377+
"/assets/Manifest.toml"
378+
link_project = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
379+
"/assets/Project.toml"
380+
Markdown.parse("""You can also download the
381+
[manifest]($link_manifest)
382+
file and the
383+
[project]($link_project)
384+
file.
385+
""")
399386
```

0 commit comments

Comments
 (0)