Skip to content

Commit 0ee7d99

Browse files
committed
added reproducibility info to README and make.jl.
1 parent 6c4ab81 commit 0ee7d99

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,3 +225,58 @@ Load that package if ReverseDiff overloads are required.
225225
[AutoPreallocation.jl](https://github.com/oxinabox/AutoPreallocation.jl) tries
226226
to do this automatically at the compiler level. [Alloc.jl](https://github.com/FluxML/Alloc.jl)
227227
tries to do this with a bump allocator.
228+
229+
## Reproducibility
230+
```@raw html
231+
<details><summary>The documentation of this SciML package was build using these direct dependencies,</summary>
232+
```
233+
```@example
234+
using Pkg # hide
235+
Pkg.status() # hide
236+
```
237+
```@raw html
238+
</details>
239+
```
240+
```@raw html
241+
<details><summary>and using this machine and Julia version.</summary>
242+
```
243+
```@example
244+
using InteractiveUtils # hide
245+
versioninfo() # hide
246+
```
247+
```@raw html
248+
</details>
249+
```
250+
```@raw html
251+
<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
252+
```
253+
```@example
254+
using Pkg # hide
255+
Pkg.status(;mode = PKGMODE_MANIFEST) # hide
256+
```
257+
```@raw html
258+
</details>
259+
```
260+
```@raw html
261+
You can also download the
262+
<a href="
263+
```
264+
```@eval
265+
using TOML
266+
version = TOML.parse(read("../../Project.toml",String))["version"]
267+
name = TOML.parse(read("../../Project.toml",String))["name"]
268+
link = "https://github.com/SciML/"*name*".jl/tree/gh-pages/v"*version*"/assets/Manifest.toml"
269+
```
270+
```@raw html
271+
">manifest</a> file and the
272+
<a href="
273+
```
274+
```@eval
275+
using TOML
276+
version = TOML.parse(read("../../Project.toml",String))["version"]
277+
name = TOML.parse(read("../../Project.toml",String))["name"]
278+
link = "https://github.com/SciML/"*name*".jl/tree/gh-pages/v"*version*"/assets/Project.toml"
279+
```
280+
```@raw html
281+
">project</a> file.
282+
```

docs/make.jl

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

0 commit comments

Comments
 (0)