Skip to content

Commit c695ddf

Browse files
Merge pull request #97 from ArnoStrouwen/repro
reproducible docs
2 parents c67c71f + f8dce10 commit c695ddf

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

docs/make.jl

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
using Documenter
22

3+
cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true)
4+
cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
5+
36
mathengine = MathJax3(Dict(:loader => Dict("load" => ["[tex]/require", "[tex]/mathtools"]),
47
:tex => Dict("inlineMath" => [["\$", "\$"], ["\\(", "\\)"]],
58
"packages" => [

docs/src/index.md

+54
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,57 @@ To install, run
3232
Z = map(x -> x[3], sol.u)
3333
plot(X, Z)
3434
```
35+
## Reproducibility
36+
```@raw html
37+
<details><summary>The documentation of this SciML package was build using these direct dependencies,</summary>
38+
```
39+
```@example
40+
using Pkg # hide
41+
Pkg.status() # hide
42+
```
43+
```@raw html
44+
</details>
45+
```
46+
```@raw html
47+
<details><summary>and using this machine and Julia version.</summary>
48+
```
49+
```@example
50+
using InteractiveUtils # hide
51+
versioninfo() # hide
52+
```
53+
```@raw html
54+
</details>
55+
```
56+
```@raw html
57+
<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
58+
```
59+
```@example
60+
using Pkg # hide
61+
Pkg.status(;mode = PKGMODE_MANIFEST) # hide
62+
```
63+
```@raw html
64+
</details>
65+
```
66+
```@raw html
67+
You can also download the
68+
<a href="
69+
```
70+
```@eval
71+
using TOML
72+
version = TOML.parse(read("../../Project.toml",String))["version"]
73+
name = TOML.parse(read("../../Project.toml",String))["name"]
74+
link = "https://github.com/SciML/"*name*".jl/tree/gh-pages/v"*version*"/assets/Manifest.toml"
75+
```
76+
```@raw html
77+
">manifest</a> file and the
78+
<a href="
79+
```
80+
```@eval
81+
using TOML
82+
version = TOML.parse(read("../../Project.toml",String))["version"]
83+
name = TOML.parse(read("../../Project.toml",String))["name"]
84+
link = "https://github.com/SciML/"*name*".jl/tree/gh-pages/v"*version*"/assets/Project.toml"
85+
```
86+
```@raw html
87+
">project</a> file.
88+
```

0 commit comments

Comments
 (0)