Merge pull request #60 from ArnoStrouwen/docs1

Documenter 1.0 upgrade
SciML · Sep 23, 2023 · 790db60 · 790db60
2 parents cb369a4 + 0201f91
commit 790db60
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 65 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -3,9 +3,13 @@ on:
   pull_request:
     branches:
       - master
+    paths-ignore:
+      - 'docs/**'
   push:
     branches:
       - master
+    paths-ignore:
+      - 'docs/**'
 jobs:
   test:
     runs-on: ubuntu-latest

diff --git a/.travis.yml b/.travis.yml
diff --git a/appveyor.yml b/appveyor.yml
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -3,5 +3,5 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 EllipsisNotation = "da5c29d0-fa7d-589e-88eb-ea29b0a81949"
 
 [compat]
-Documenter = "0.27"
+Documenter = "1"
 EllipsisNotation = "1"
diff --git a/docs/make.jl b/docs/make.jl
@@ -6,15 +6,6 @@ makedocs(sitename = "EllipsisNotation.jl",
     authors = "Chris Rackauckas",
     modules = [EllipsisNotation],
     clean = true, doctest = false, linkcheck = true,
-    strict = [
-        :doctest,
-        :linkcheck,
-        :parse_error,
-        :example_block,
-        :cross_references,
-        # Other available options are
-        # :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
-    ],
     format = Documenter.HTML(assets = ["assets/favicon.ico"],
         canonical = "https://docs.sciml.ai/EllipsisNotation/stable/"),
     pages = pages)

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -12,6 +12,7 @@ possible confusion.
 ## Installation
 
 ```julia
+using Pkg
 Pkg.add("EllipsisNotation")
 using EllipsisNotation
 ```
@@ -91,3 +92,61 @@ for more details.
 I would like to acknowledge M. Schauer for the `..` notation implementation.
 He had the original idea, I just extended it and put it into a package because
 of how useful it has been to me.
+
+## Reproducibility
+
+```@raw html
+<details><summary>The documentation of this SciML package was built using these direct dependencies,</summary>
+```
+
+```@example
+using Pkg # hide
+Pkg.status() # hide
+```
+
+```@raw html
+</details>
+```
+
+```@raw html
+<details><summary>and using this machine and Julia version.</summary>
+```
+
+```@example
+using InteractiveUtils # hide
+versioninfo() # hide
+```
+
+```@raw html
+</details>
+```
+
+```@raw html
+<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
+```
+
+```@example
+using Pkg # hide
+Pkg.status(; mode = PKGMODE_MANIFEST) # hide
+```
+
+```@raw html
+</details>
+```
+
+```@eval
+using TOML
+using Markdown
+version = TOML.parse(read("../../Project.toml", String))["version"]
+name = TOML.parse(read("../../Project.toml", String))["name"]
+link_manifest = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
+                "/assets/Manifest.toml"
+link_project = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
+               "/assets/Project.toml"
+Markdown.parse("""You can also download the
+[manifest]($link_manifest)
+file and the
+[project]($link_project)
+file.
+""")
+```