From e252d79d07c83bf59fe947b3bb55a213e91b8692 Mon Sep 17 00:00:00 2001 From: ArnoStrouwen Date: Thu, 10 Nov 2022 15:21:13 +0100 Subject: [PATCH] reproducible docs --- docs/make.jl | 3 +++ docs/src/index.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) diff --git a/docs/make.jl b/docs/make.jl index 1d1c80a..9d787b9 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,5 +1,8 @@ using Documenter, LabelledArrays +cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true) +cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true) + include("pages.jl") makedocs(sitename = "LabelledArrays.jl", diff --git a/docs/src/index.md b/docs/src/index.md index 667895b..4373908 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -24,3 +24,58 @@ Pkg.add("LabelledArrays") - [JuliaDiffEq](https://gitter.im/JuliaDiffEq/Lobby) on Gitter - on the [Julia Discourse forums](https://discourse.julialang.org) - see also [SciML Community page](https://sciml.ai/community/) + +## Reproducibility +```@raw html +
The documentation of this SciML package was build using these direct dependencies, +``` +```@example +using Pkg # hide +Pkg.status() # hide +``` +```@raw html +
+``` +```@raw html +
and using this machine and Julia version. +``` +```@example +using InteractiveUtils # hide +versioninfo() # hide +``` +```@raw html +
+``` +```@raw html +
A more complete overview of all dependencies and their versions is also provided. +``` +```@example +using Pkg # hide +Pkg.status(;mode = PKGMODE_MANIFEST) # hide +``` +```@raw html +
+``` +```@raw html +You can also download the +manifest file and the +project file. +``` \ No newline at end of file