From b4920f7ae745651147e12d7ec169c4871d02034e Mon Sep 17 00:00:00 2001
From: Carlo Lucibello <carlo.lucibello@gmail.com>
Date: Tue, 2 Apr 2024 16:20:05 +0200
Subject: [PATCH] fix broken documentation (#172)

* fix docs

* cleanup
---
 .gitignore      |   2 ++
 docs/.DS_Store  | Bin 0 -> 6148 bytes
 docs/make.jl    |   2 +-
 docs/src/api.md |   2 ++
 4 files changed, 5 insertions(+), 1 deletion(-)
 create mode 100644 docs/.DS_Store

diff --git a/.gitignore b/.gitignore
index e4fecbbe..952f7cea 100644
--- 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
new file mode 100644
index 0000000000000000000000000000000000000000..e14553107e0e9f4dfeb62498c2852eba47071535
GIT binary patch
literal 6148
zcmeHK&2G~`5T4Bs-B5vY0JX<OTq98fJycxWklqnS^iZl0*HLTXc%wLJ4pAf@5E8sW
zZ&k&)SDv7+&<j$Zr8B!*YLg&t2*Hdr`|Zxp?)tN}>j41Ko<tr%696PCVWol15+Oh7
zf>fO4E}}4VMBy|WhKUXrV%hL_GC=RH4k1h+h6IZ5?^`%b;%vOJaVaX*TK&$7T#>7C
zKRD9UVB8x|vUYE@N251dC*e)M7ru@A({A&@OP!8;aoQi5ggEMB$h+M*jr6pwCux+K
z+`u|yLpHk2wb|_XvzGF<<}Eezo^Eco)RyPX=MDMr@sk&?yC0H4sy|yE1%7Zw?m4`H
zFW4zOP;%%62YN8HvERRzy#w9pxX)F7+&_P`es!_^b42u;h~ZITh5N5)p~Cvd!6;31
zdWcrqaTPKc!9i(P;*+}d6nAuTepX+zJ92pgeY=}QZ)qpu6ene22ABb6U^xTs2$ieL
z-E3tBn1TP80XiQPDxvQ%w`h(IY)lD&SVOZB>{Bg4Im)5$Ft>;v6k$^lZK`l3hOp^q
zS1!(Xm|L{zAYAbw+{(gLD8j6c^D7e$!nepRGr$a#8K~M}lkWeWU)TTTBpxvX%)mdz
zfT(qXP8%P|-K`4`M|Z74eUC~)ak<4GDcCVrF~-tWypC!F?TR{xzQf!iT2S~$z|g=A
JGw??lxCZy@gAM=y

literal 0
HcmV?d00001

diff --git a/docs/make.jl b/docs/make.jl
index 8d0504b2..47d64137 100644
--- 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
index 661f83bc..5648d167 100644
--- 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
 ```