Skip to content

Commit a517f8b

Browse files
Merge pull request #231 from ArnoStrouwen/master
reproducible docs
2 parents 0236f64 + 8832a8a commit a517f8b

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

docs/make.jl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
using Documenter, RecursiveArrayTools
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
include("pages.jl")
47

58
makedocs(

docs/src/index.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,58 @@ Pkg.add("RecursiveArrayTools")
2525
- [JuliaDiffEq](https://gitter.im/JuliaDiffEq/Lobby) on Gitter
2626
- on the [Julia Discourse forums](https://discourse.julialang.org)
2727
- see also [SciML Community page](https://sciml.ai/community/)
28+
29+
## Reproducibility
30+
```@raw html
31+
<details><summary>The documentation of this SciML package was build using these direct dependencies,</summary>
32+
```
33+
```@example
34+
using Pkg # hide
35+
Pkg.status() # hide
36+
```
37+
```@raw html
38+
</details>
39+
```
40+
```@raw html
41+
<details><summary>and using this machine and Julia version.</summary>
42+
```
43+
```@example
44+
using InteractiveUtils # hide
45+
versioninfo() # hide
46+
```
47+
```@raw html
48+
</details>
49+
```
50+
```@raw html
51+
<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
52+
```
53+
```@example
54+
using Pkg # hide
55+
Pkg.status(;mode = PKGMODE_MANIFEST) # hide
56+
```
57+
```@raw html
58+
</details>
59+
```
60+
```@raw html
61+
You can also download the
62+
<a href="
63+
```
64+
```@eval
65+
using TOML
66+
version = TOML.parse(read("../../Project.toml",String))["version"]
67+
name = TOML.parse(read("../../Project.toml",String))["name"]
68+
link = "https://github.com/SciML/"*name*".jl/tree/gh-pages/v"*version*"/assets/Manifest.toml"
69+
```
70+
```@raw html
71+
">manifest</a> file and the
72+
<a href="
73+
```
74+
```@eval
75+
using TOML
76+
version = TOML.parse(read("../../Project.toml",String))["version"]
77+
name = TOML.parse(read("../../Project.toml",String))["name"]
78+
link = "https://github.com/SciML/"*name*".jl/tree/gh-pages/v"*version*"/assets/Project.toml"
79+
```
80+
```@raw html
81+
">project</a> file.
82+
```

0 commit comments

Comments
 (0)