Skip to content

Commit 925263f

Browse files
committed
added reproducibility info to docs
1 parent b4d508b commit 925263f

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
@@ -541,3 +541,58 @@ for sparsity patterns. In the future, those two packages should just depend on
541541
ArrayInterface.jl and remove this issue entirely from the user space.
542542

543543
Additionally, GPUs need ArrayInterfaceGPUArrays for proper determination of the indexing.
544+
545+
## Reproducibility
546+
```@raw html
547+
<details><summary>The documentation of this SciML package was build using these direct dependencies,</summary>
548+
```
549+
```@example
550+
using Pkg # hide
551+
Pkg.status() # hide
552+
```
553+
```@raw html
554+
</details>
555+
```
556+
```@raw html
557+
<details><summary>and using this machine and Julia version.</summary>
558+
```
559+
```@example
560+
using InteractiveUtils # hide
561+
versioninfo() # hide
562+
```
563+
```@raw html
564+
</details>
565+
```
566+
```@raw html
567+
<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
568+
```
569+
```@example
570+
using Pkg # hide
571+
Pkg.status(;mode = PKGMODE_MANIFEST) # hide
572+
```
573+
```@raw html
574+
</details>
575+
```
576+
```@raw html
577+
You can also download the
578+
<a href="
579+
```
580+
```@eval
581+
using TOML
582+
version = TOML.parse(read("../../Project.toml",String))["version"]
583+
name = TOML.parse(read("../../Project.toml",String))["name"]
584+
link = "https://github.com/SciML/"*name*".jl/tree/gh-pages/v"*version*"/assets/Manifest.toml"
585+
```
586+
```@raw html
587+
">manifest</a> file and the
588+
<a href="
589+
```
590+
```@eval
591+
using TOML
592+
version = TOML.parse(read("../../Project.toml",String))["version"]
593+
name = TOML.parse(read("../../Project.toml",String))["name"]
594+
link = "https://github.com/SciML/"*name*".jl/tree/gh-pages/v"*version*"/assets/Project.toml"
595+
```
596+
```@raw html
597+
">project</a> file.
598+
```

docs/make.jl

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

0 commit comments

Comments
 (0)