Skip to content

Commit fc1f6cb

Browse files
Merge pull request #154 from 00krishna-opensource/add_reproducibility
added reproducibility info to docs
2 parents b4d508b + 4555bc4 commit fc1f6cb

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-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, 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",

docs/src/index.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -555,5 +555,59 @@ Additionally, GPUs need ArrayInterfaceGPUArrays for proper determination of the
555555
- See also [SciML Community page](https://sciml.ai/community/)
556556

557557

558+
## Reproducibility
559+
```@raw html
560+
<details><summary>The documentation of this SciML package was built using these direct dependencies,</summary>
561+
```
562+
```@example
563+
using Pkg # hide
564+
Pkg.status() # hide
565+
```
566+
```@raw html
567+
</details>
568+
```
569+
```@raw html
570+
<details><summary>and using this machine and Julia version.</summary>
571+
```
572+
```@example
573+
using InteractiveUtils # hide
574+
versioninfo() # hide
575+
```
576+
```@raw html
577+
</details>
578+
```
579+
```@raw html
580+
<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
581+
```
582+
```@example
583+
using Pkg # hide
584+
Pkg.status(;mode = PKGMODE_MANIFEST) # hide
585+
```
586+
```@raw html
587+
</details>
588+
```
589+
```@raw html
590+
You can also download the
591+
<a href="
592+
```
593+
```@eval
594+
using TOML
595+
version = TOML.parse(read("../../Project.toml",String))["version"]
596+
name = TOML.parse(read("../../Project.toml",String))["name"]
597+
link = "https://github.com/SciML/"*name*".jl/tree/gh-pages/v"*version*"/assets/Manifest.toml"
598+
```
599+
```@raw html
600+
">manifest</a> file and the
601+
<a href="
602+
```
603+
```@eval
604+
using TOML
605+
version = TOML.parse(read("../../Project.toml",String))["version"]
606+
name = TOML.parse(read("../../Project.toml",String))["name"]
607+
link = "https://github.com/SciML/"*name*".jl/tree/gh-pages/v"*version*"/assets/Project.toml"
608+
```
609+
```@raw html
610+
">project</a> file.
611+
```
558612

559613

0 commit comments

Comments
 (0)