Fix the doctests and the broken CI (#98)

* Fix the doctests and the broken CI

* Add `Functors.jl` as a doc dependency

Author: Saransh-cpp

.github/workflows/ci.yml

@@ -67,7 +67,7 @@ jobs:
             Pkg.develop(PackageSpec(path=pwd()))
             Pkg.instantiate()'
       - run: |
-          julia --project=docs/ -e '
+          julia --color=yes --project=docs/ -e '
             using Optimisers
             using Documenter
             using Documenter: doctest

docs/Project.toml

@@ -1,2 +1,5 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Functors = "d9f16b24-f501-4c13-a1f2-28368ffc5196"
+StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
+Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"

docs/make.jl

@@ -1,9 +1,9 @@
-using Documenter, Optimisers
+using Documenter, Optimisers, Zygote, StaticArrays, Functors
 
 DocMeta.setdocmeta!(Optimisers, :DocTestSetup, :(using Optimisers); recursive = true)
 
-makedocs(modules = [Optimisers],
-         doctest = VERSION == v"1.6",
+makedocs(modules = [Optimisers, Zygote, StaticArrays, Functors],
+         doctest = false,
          sitename = "Optimisers.jl",
          pages = ["Home" => "index.md",
                   "API" => "api.md"],

src/Optimisers.jl

@@ -74,21 +74,21 @@ The recursion into structures uses Functors.jl, and any new `struct`s containing
 need to be marked with `Functors.@functor` before use.
 See [the Flux docs](https://fluxml.ai/Flux.jl/stable/models/advanced/) for more about this.
 
-```
+```jldoctest
 julia> struct Layer; mat; fun; end
 
 julia> model = (lay = Layer([1 2; 3 4f0], sin), vec = [5, 6f0]);
 
 julia> Optimisers.setup(Momentum(), model)  # new struct is by default ignored
-(lay = nothing, vec = Leaf(Momentum{Float32}(0.01, 0.9), [0.0, 0.0]))
+(lay = nothing, vec = Leaf(Momentum{Float32}(0.01, 0.9), Float32[0.0, 0.0]))
 
 julia> destructure(model)
 (Float32[5.0, 6.0], Restructure(NamedTuple, ..., 2))
 
 julia> using Functors; @functor Layer  # annotate this type as containing parameters
 
 julia> Optimisers.setup(Momentum(), model)
-(lay = (mat = Leaf(Momentum{Float32}(0.01, 0.9), [0.0 0.0; 0.0 0.0]), fun = nothing), vec = Leaf(Momentum{Float32}(0.01, 0.9), [0.0, 0.0]))
+(lay = (mat = Leaf(Momentum{Float32}(0.01, 0.9), Float32[0.0 0.0; 0.0 0.0]), fun = nothing), vec = Leaf(Momentum{Float32}(0.01, 0.9), Float32[0.0, 0.0]))
 
 julia> destructure(model)
 (Float32[1.0, 3.0, 2.0, 4.0, 5.0, 6.0], Restructure(NamedTuple, ..., 6))