Skip to content

Commit 169b1cc

Browse files
Merge pull request #148 from ArnoStrouwen/docs1
Documenter 1.0 upgrade
2 parents 1517c89 + ed30f67 commit 169b1cc

File tree

4 files changed

+25
-40
lines changed

4 files changed

+25
-40
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
LabelledArrays = "2ee39098-c373-598a-b85f-a56591580800"
44

55
[compat]
6-
Documenter = "0.27"
6+
Documenter = "1"
77
LabelledArrays = "1.12"

docs/make.jl

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,7 @@ makedocs(sitename = "LabelledArrays.jl",
99
authors = "Chris Rackauckas",
1010
modules = [LabelledArrays],
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+
format = Documenter.HTML(assets = ["assets/favicon.ico"],
2213
canonical = "https://docs.sciml.ai/LabelledArrays/stable/"),
2314
pages = pages)
2415

docs/src/index.md

Lines changed: 19 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,15 @@ Pkg.add("LabelledArrays")
2020
[SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md)
2121
for guidance on PRs, issues, and other matters relating to contributing to SciML.
2222

23+
- See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions.
2324
- There are a few community forums:
2425

25-
+ the #diffeq-bridged channel in the [Julia Slack](https://julialang.org/slack/)
26-
+ [JuliaDiffEq](https://gitter.im/JuliaDiffEq/Lobby) on Gitter
27-
+ on the [Julia Discourse forums](https://discourse.julialang.org)
28-
+ see also [SciML Community page](https://sciml.ai/community/)
26+
+ The #diffeq-bridged and #sciml-bridged channels in the
27+
[Julia Slack](https://julialang.org/slack/)
28+
+ The #diffeq-bridged and #sciml-bridged channels in the
29+
[Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
30+
+ On the [Julia Discourse forums](https://discourse.julialang.org)
31+
+ See also [SciML Community page](https://sciml.ai/community/)
2932

3033
## Reproducibility
3134

@@ -68,32 +71,19 @@ Pkg.status(; mode = PKGMODE_MANIFEST) # hide
6871
</details>
6972
```
7073

71-
```@raw html
72-
You can also download the
73-
<a href="
74-
```
75-
76-
```@eval
77-
using TOML
78-
version = TOML.parse(read("../../Project.toml", String))["version"]
79-
name = TOML.parse(read("../../Project.toml", String))["name"]
80-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
81-
"/assets/Manifest.toml"
82-
```
83-
84-
```@raw html
85-
">manifest</a> file and the
86-
<a href="
87-
```
88-
8974
```@eval
9075
using TOML
76+
using Markdown
9177
version = TOML.parse(read("../../Project.toml", String))["version"]
9278
name = TOML.parse(read("../../Project.toml", String))["name"]
93-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
94-
"/assets/Project.toml"
95-
```
96-
97-
```@raw html
98-
">project</a> file.
99-
```
79+
link_manifest = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
80+
"/assets/Manifest.toml"
81+
link_project = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
82+
"/assets/Project.toml"
83+
Markdown.parse("""You can also download the
84+
[manifest]($link_manifest)
85+
file and the
86+
[project]($link_project)
87+
file.
88+
""")
89+
```

0 commit comments

Comments
 (0)