From ac6cb33c990049ccedf735e63b9fdbff5699f1a5 Mon Sep 17 00:00:00 2001 From: Dilum Aluthge Date: Sun, 27 Aug 2023 19:06:30 -0400 Subject: [PATCH 1/7] CI: fix the YAML syntax for the docs job --- .github/workflows/ci.yml | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1c74b40e0..febf81ac5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -81,20 +81,21 @@ jobs: set_environment_variable("BUILD_DOCS", "false") end' - run: | - julia --project=docs -e ' - if ENV["BUILD_DOCS"] == "true" - using Pkg - Pkg.develop(PackageSpec(path=pwd())) - Pkg.instantiate() - end' - - run: julia --project=docs -e ' - if ENV["BUILD_DOCS"] == "true" - @info "attempting to build the docs" - run(`julia --project=docs docs/make.jl`) - @info "successfully built the docs" - else - @info "skipping the docs build" - end' + if ENV["BUILD_DOCS"] == "true" + using Pkg + Pkg.develop(PackageSpec(path=pwd())) + Pkg.instantiate() + end + shell: julia --color=yes --project=docs {0} + - run: | + if ENV["BUILD_DOCS"] == "true" + @info "attempting to build the docs" + run(`julia --project=docs docs/make.jl`) + @info "successfully built the docs" + else + @info "skipping the docs build" + end + shell: julia --color=yes --project=docs {0} env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} From dd3f98726f6404478070608f8fff504e8102d970 Mon Sep 17 00:00:00 2001 From: Dilum Aluthge Date: Sun, 27 Aug 2023 19:12:43 -0400 Subject: [PATCH 2/7] Update ci.yml --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index febf81ac5..0b8e61187 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -88,7 +88,7 @@ jobs: end shell: julia --color=yes --project=docs {0} - run: | - if ENV["BUILD_DOCS"] == "true" + if ENV["BUILD_DOCS"] != "true" @info "attempting to build the docs" run(`julia --project=docs docs/make.jl`) @info "successfully built the docs" From 8c937699150975fce55a3f77ea08bd9af984838c Mon Sep 17 00:00:00 2001 From: Dilum Aluthge Date: Sun, 27 Aug 2023 19:14:02 -0400 Subject: [PATCH 3/7] Update ci.yml --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0b8e61187..a5791ed2a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -81,7 +81,7 @@ jobs: set_environment_variable("BUILD_DOCS", "false") end' - run: | - if ENV["BUILD_DOCS"] == "true" + if ENV["BUILD_DOCS"] != "true" using Pkg Pkg.develop(PackageSpec(path=pwd())) Pkg.instantiate() From 3a9f3037bcc5406222ae3b5e7157d2de206541ed Mon Sep 17 00:00:00 2001 From: Dilum Aluthge Date: Mon, 28 Aug 2023 03:08:30 -0400 Subject: [PATCH 4/7] Update ci.yml --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a5791ed2a..febf81ac5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -81,14 +81,14 @@ jobs: set_environment_variable("BUILD_DOCS", "false") end' - run: | - if ENV["BUILD_DOCS"] != "true" + if ENV["BUILD_DOCS"] == "true" using Pkg Pkg.develop(PackageSpec(path=pwd())) Pkg.instantiate() end shell: julia --color=yes --project=docs {0} - run: | - if ENV["BUILD_DOCS"] != "true" + if ENV["BUILD_DOCS"] == "true" @info "attempting to build the docs" run(`julia --project=docs docs/make.jl`) @info "successfully built the docs" From d66d8291acd213adfd39530adebfeb121144352b Mon Sep 17 00:00:00 2001 From: Dilum Aluthge Date: Mon, 28 Aug 2023 19:53:53 -0400 Subject: [PATCH 5/7] Build the docs --- .github/workflows/ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index febf81ac5..93d16211d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -73,6 +73,7 @@ jobs: else build_docs = false end + build_docs = true # TODO: delete this debugging line if build_docs @info("We will build the docs") set_environment_variable("BUILD_DOCS", "true") From 07acd86d2466679ecdfcef4d026c49eedeb752d0 Mon Sep 17 00:00:00 2001 From: Dilum Aluthge Date: Wed, 30 Aug 2023 22:17:17 -0400 Subject: [PATCH 6/7] Revert d66d8291acd213adfd39530adebfeb121144352b --- .github/workflows/ci.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 93d16211d..febf81ac5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -73,7 +73,6 @@ jobs: else build_docs = false end - build_docs = true # TODO: delete this debugging line if build_docs @info("We will build the docs") set_environment_variable("BUILD_DOCS", "true") From 1ef851db77ac1481a2cfbc5fdcbe2d0dbe30a02c Mon Sep 17 00:00:00 2001 From: "Anthony D. Blaom" Date: Mon, 4 Sep 2023 14:41:41 +1200 Subject: [PATCH 7/7] fine tune documenter options and bump documeter version --- docs/Project.toml | 2 +- docs/make.jl | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Project.toml b/docs/Project.toml index bee9165d8..ee3cd3f2e 100755 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -30,7 +30,7 @@ TypedTables = "9d95f2ec-7b3d-5a63-8d20-e2491e220bb9" [compat] CategoricalDistributions = "0.1" -Documenter = "0.26" +Documenter = "0.27" MLJEnsembles = "0.3" MLJIteration = "0.5" MLJModels = "0.16" diff --git a/docs/make.jl b/docs/make.jl index f4d13ec69..d0c3992ea 100755 --- a/docs/make.jl +++ b/docs/make.jl @@ -114,7 +114,7 @@ makedocs( IterationControl, CategoricalDistributions], pages = pages, - strict = true + strict = Documenter.except(:cross_references, :missing_docs), ) # By default Documenter does not deploy docs just for PR