Merge pull request #1048 from alan-turing-institute/dev

Update docs
JuliaAI · Sep 4, 2023 · e5f88c2 · e5f88c2
2 parents 01cfe19 + 1ef851d
commit e5f88c2
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 16 deletions.
diff --git 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 }}
diff --git 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
@@ -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