From ec07d34471a4b824be4296166a74dfa4ee69460e Mon Sep 17 00:00:00 2001 From: Arno Strouwen Date: Mon, 25 Sep 2023 07:35:49 +0200 Subject: [PATCH] start Documenter 1.0 upgrade --- .github/workflows/ci.yml | 4 +++ docs/Project.toml | 2 +- docs/make.jl | 15 +++-------- docs/src/index.md | 58 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 66 insertions(+), 13 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cefa73be8..07921ddfe 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..306eb518e 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -18,19 +18,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 5bb52465b..bda1e63a3 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -80,3 +80,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