From b8e849697c49f1447df5b1666b07ea8cf3046ad4 Mon Sep 17 00:00:00 2001 From: Arno Strouwen Date: Mon, 25 Sep 2023 07:45:35 +0200 Subject: [PATCH 1/3] start Documenter 1.0 upgrade --- .github/workflows/ci.yml | 4 +++ docs/Project.toml | 2 +- docs/make.jl | 18 +++++-------- docs/src/index.md | 58 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 69 insertions(+), 13 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c006cb136..b033b6fe6 100644 --- 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/docs/Project.toml b/docs/Project.toml index 0edd8d5a1..9a18ffb63 100644 --- a/docs/Project.toml +++ b/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" diff --git a/docs/make.jl b/docs/make.jl index 23a697e8b..0e00255f3 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,5 +1,8 @@ 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" using Plots @@ -18,19 +21,10 @@ 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, + 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", diff --git a/docs/src/index.md b/docs/src/index.md index f4b05201a..9d4df3950 100644 --- a/docs/src/index.md +++ b/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 +
The documentation of this SciML package was built 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 +
+``` + +```@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. +""") +``` \ No newline at end of file From 5dc7f534c236e508595d9c024cdd4976deaf4f56 Mon Sep 17 00:00:00 2001 From: ArnoStrouwen Date: Mon, 16 Oct 2023 14:11:42 +0200 Subject: [PATCH 2/3] enable doc debug --- docs/make.jl | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/make.jl b/docs/make.jl index 0e00255f3..10fe84148 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -5,6 +5,7 @@ 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"]), From 71a3104e7e97a1ed6c634d20b7d13002a3a29df9 Mon Sep 17 00:00:00 2001 From: Arno Strouwen Date: Wed, 18 Oct 2023 06:23:04 +0200 Subject: [PATCH 3/3] continue doc 1.0 upgrade --- docs/make.jl | 1 + docs/src/getting_started.md | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/make.jl b/docs/make.jl index 10fe84148..47b95cc85 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -23,6 +23,7 @@ makedocs( authors="Chris Rackauckas", modules=[Symbolics,SymbolicUtils], clean=true, doctest=false, linkcheck = true, + warnonly = [:docs_block, :missing_docs, :cross_references], format = Documenter.HTML(assets = ["assets/favicon.ico"], mathengine = mathengine, canonical="https://docs.sciml.ai/Symbolics/stable/"), diff --git a/docs/src/getting_started.md b/docs/src/getting_started.md index ab9105b03..5f381a432 100644 --- a/docs/src/getting_started.md +++ b/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`: