Doctestfix (#568)

* merge * better warning filter * more doctest filters * more robust against varying line breaks * Remove double doctest * get warning early * fix sizedmatrix doctest error Co-authored-by: Albin Heimerson <albin.heimerson@control.lth.se>
JuliaControl · Nov 7, 2021 · bd2cfc2 · bd2cfc2
1 parent 7533957
commit bd2cfc2
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 13 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -44,15 +44,7 @@ jobs:
             using Pkg
             Pkg.develop(PackageSpec(path=pwd()))
             Pkg.instantiate()'
-      - name: Test docs # Test are also run in the makedocs, but there they don't error properly unless we set strict in which case warnings also error
-        run: |
-          julia --project=docs -e '
-            ENV["PLOTS_TEST"] = "true"
-            ENV["GKSwstype"] = "nul"
-            using Documenter: doctest
-            using ControlSystems
-            doctest(ControlSystems)'
-      - name: Generate documentation
+      - name: Make documentation and run doctest
         run: julia --project=docs --color=yes docs/make.jl
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -9,3 +9,4 @@ StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 
 [compat]
 StaticArrays = "0.12"
+Documenter = "0.27.10"
diff --git a/docs/make.jl b/docs/make.jl
@@ -30,7 +30,13 @@ println("Making docs")
 makedocs(modules=[ControlSystems],
     format=Documenter.HTML(),
     sitename="ControlSystems.jl",
-    #strict=true,
+    strict=[
+        :doctest, 
+        :linkcheck, 
+        :parse_error, 
+        # Other available options are
+        # :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
+    ],
     pages=[
         "Home" => "index.md",
         "Guide" => Any[

diff --git a/docs/src/examples/example.md b/docs/src/examples/example.md
@@ -3,6 +3,7 @@ DocTestSetup = quote
     using ControlSystems, Plots
     plotsDir = joinpath(dirname(pathof(ControlSystems)), "..", "docs", "build", "plots")
     mkpath(plotsDir)
+    nyquistplot(ssrand(1,1,1)) # to get the warning for hover already here
     save_docs_plot(name) = Plots.savefig(joinpath(plotsDir,name))
     save_docs_plot(p, name) = Plots.savefig(p, joinpath(plotsDir,name))
 end

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -7,7 +7,8 @@ DocTestFilters = [
     r"HeteroStateSpace.+?\n"
     r"TransferFunction.+?\n"
     r"DelayLtiSystem.+?\n"
-    r"┌ Warning: Keyword argument hover.+?\n.+?\n" # remove next line as well
+    r"┌ Warning: Keyword argument hover.+\n*.+\n*" # remove next line as well
+    r"\[ Info: Precompiling.+\n*"
 ]
 ```
 

diff --git a/docs/src/man/creating_systems.md b/docs/src/man/creating_systems.md
@@ -121,7 +121,7 @@ D =
 Continuous-time state-space model
 
 julia> HeteroStateSpace(sys, to_sized)
-HeteroStateSpace{Continuous, SizedMatrix{2, 2, Int64, 2, Matrix{Int64}}, SizedMatrix{2, 1, Int64, 2, Matrix{Int64}}, SizedMatrix{1, 2, Int64, 2, Matrix{Int64}}, SizedMatrix{1, 1, Int64, 2, Matrix{Int64}}}
+HeteroStateSpace{Continuous, SizedMatrix{2, 2, Int64, 2}, SizedMatrix{2, 1, Int64, 2}, SizedMatrix{1, 2, Int64, 2}, SizedMatrix{1, 1, Int64, 2}}
 A =
  -5   0
   0  -5

diff --git a/src/freqresp.jl b/src/freqresp.jl
@@ -168,7 +168,7 @@ function _bounds_and_features(sys::LTISystem, plot::Val)
         w2 = ceil(fzp[end] + 1.2)
         # Expand the range for nyquist plots
         if plot isa Val{:nyquist}
-            w1 -= 1.0
+            w1 -= 0.0
             w2 += 1.0
         end
     else