Skip to content

Commit b379999

Browse files
Merge pull request #214 from ArnoStrouwen/main
prototype reproducibility docs
2 parents 1185902 + 18a881f commit b379999

File tree

2 files changed

+59
-1
lines changed

2 files changed

+59
-1
lines changed

docs/make.jl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
using LinearSolve
22
using Documenter
33

4+
cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true)
5+
cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
6+
47
DocMeta.setdocmeta!(LinearSolve, :DocTestSetup, :(using LinearSolve); recursive = true)
58

69
include("pages.jl")

docs/src/index.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,59 @@ Pkg.add("LinearSolve")
3939
Wrappers for every linear solver in the Julia language is on the roadmap. If
4040
there are any important ones that are missing that you would like to see added,
4141
please open an issue. The current algorithms should support automatic differentiation.
42-
Pre-defined preconditioners would be a welcome addition.
42+
Pre-defined preconditioners would be a welcome addition.
43+
44+
## Reproducibility
45+
```@raw html
46+
<details><summary>The documentation of this SciML package was build using these direct dependencies,</summary>
47+
```
48+
```@example
49+
using Pkg # hide
50+
Pkg.status() # hide
51+
```
52+
```@raw html
53+
</details>
54+
```
55+
```@raw html
56+
<details><summary>and using this machine and Julia version.</summary>
57+
```
58+
```@example
59+
using InteractiveUtils # hide
60+
versioninfo() # hide
61+
```
62+
```@raw html
63+
</details>
64+
```
65+
```@raw html
66+
<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
67+
```
68+
```@example
69+
using Pkg # hide
70+
Pkg.status(;mode = PKGMODE_MANIFEST) # hide
71+
```
72+
```@raw html
73+
</details>
74+
```
75+
```@raw html
76+
You can also download the
77+
<a href="
78+
```
79+
```@eval
80+
using TOML
81+
version = TOML.parse(read("../../Project.toml",String))["version"]
82+
name = TOML.parse(read("../../Project.toml",String))["name"]
83+
link = "https://github.com/SciML/"*name*".jl/tree/gh-pages/v"*version*"/assets/Manifest.toml"
84+
```
85+
```@raw html
86+
">manifest</a> file and the
87+
<a href="
88+
```
89+
```@eval
90+
using TOML
91+
version = TOML.parse(read("../../Project.toml",String))["version"]
92+
name = TOML.parse(read("../../Project.toml",String))["name"]
93+
link = "https://github.com/SciML/"*name*".jl/tree/gh-pages/v"*version*"/assets/Project.toml"
94+
```
95+
```@raw html
96+
">project</a> file.
97+
```

0 commit comments

Comments
 (0)