Merge pull request #978 from ArnoStrouwen/docs1

start Documenter 1.0 upgrade

Author: ChrisRackauckas

.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

docs/Project.toml

@@ -10,7 +10,7 @@ Symbolics = "0c5d862f-8b57-4792-8d23-62f2024744c7"
 
 [compat]
 BenchmarkTools = "1.3"
-Documenter = "0.27"
+Documenter = "1"
 Latexify = "0.15, 0.16"
 OrdinaryDiffEq = "6.31"
 Plots = "1.36"

docs/make.jl

@@ -1,7 +1,11 @@
 using Documenter, Symbolics, SymbolicUtils
 
+cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true)
+cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
+
 # Make sure that plots don't throw a bunch of warnings / errors!
 ENV["GKSwstype"] = "100"
+ENV["JULIA_DEBUG"] = "Documenter"
 using Plots
 
 mathengine = MathJax3(Dict(:loader => Dict("load" => ["[tex]/require", "[tex]/mathtools"]),
@@ -18,19 +22,11 @@ makedocs(
     sitename="Symbolics.jl",
     authors="Chris Rackauckas",
     modules=[Symbolics,SymbolicUtils],
-    clean=true,doctest=false,
-    strict=[
-        :doctest,
-        :linkcheck,
-        :parse_error,
-        :example_block,
-        # Other available options are
-        # :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
-    ],
-    format = Documenter.HTML(#analytics = "UA-90474609-3",
-                             assets = ["assets/favicon.ico"]),
+    clean=true, doctest=false, linkcheck = true,
+    warnonly = [:docs_block, :missing_docs, :cross_references],
+    format = Documenter.HTML(assets = ["assets/favicon.ico"],
                              mathengine = mathengine,
-                             #canonical="https://mtk.sciml.ai/stable/"),
+                             canonical="https://docs.sciml.ai/Symbolics/stable/"),
     pages=[
         "Home" => "index.md",
         "getting_started.md",

docs/src/getting_started.md

@@ -328,6 +328,7 @@ a function via a sparse matrix. For example:
 using LinearAlgebra
 N = 8
 A = sparse(Tridiagonal([x^i for i in 1:N-1], [x^i * y^(8-i) for i in 1:N], [y^i for i in 1:N-1]))
+show(A)
 ```
 
 Now we call `build_function`:

docs/src/index.md

@@ -81,3 +81,61 @@ to be listed here, feel free to open a pull request!
 - [ReversePropagation.jl](https://github.com/dpsanders/ReversePropagation.jl): Source-to-source reverse mode automatic differentiation
     - Automated tracing of code and construction of backpropagation equations
     - Composes with symbolic transformation and simplification functionality
+
+## 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.
+""")
+```