fix broken documentation (#172)

* fix docs * cleanup
FluxML · Apr 2, 2024 · b4920f7 · b4920f7
1 parent 4132da4
commit b4920f7
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,4 @@
 Manifest.toml
 .vscode/
+docs/build/
+.DS_Store
diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/make.jl b/docs/make.jl
@@ -2,7 +2,7 @@ using Documenter, Optimisers, Zygote, StaticArrays, Functors
 
 DocMeta.setdocmeta!(Optimisers, :DocTestSetup, :(using Optimisers); recursive = true)
 
-makedocs(modules = [Optimisers, Zygote, StaticArrays, Functors],
+makedocs(modules = [Optimisers],
          doctest = false,
          sitename = "Optimisers.jl",
          pages = ["Home" => "index.md",

diff --git a/docs/src/api.md b/docs/src/api.md
@@ -51,6 +51,7 @@ To further restrict this by ignoring some fields of a layer type, define `traina
 ```@docs
 Optimisers.trainable
 Optimisers.isnumeric
+Optimisers.maywrite
 ```
 
 Such restrictions are also obeyed by this function for flattening a model:
@@ -68,4 +69,5 @@ Optimisers.init
 Optimisers.@..
 Optimisers.@lazy
 Optimisers.adjust(::AbstractRule, ::Real)
+Optimisers.@def
 ```