docs: base docs

kozistr · Sep 10, 2023 · 78d76aa · 78d76aa
1 parent 30871ed
commit 78d76aa
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 34 deletions.
diff --git a/docs/base.md b/docs/base.md
@@ -0,0 +1,5 @@
+# Base
+
+::: pytorch_optimizer.base.optimizer.BaseOptimizer
+    :docstring:
+    :members:
diff --git a/docs/index.md b/docs/index.md
@@ -1,9 +1,11 @@
 # Welcome to pytorch-optimizer
 
-[optimizer docs](optimizer)
+[base docs](./base)
 
-[lr_scheduler docs](lr_scheduler)
+[optimizer docs](./optimizer)
 
-[loss docs](loss)
+[lr_scheduler docs](./lr_scheduler)
 
-[util docs](util)
+[loss docs](./loss)
+
+[util docs](./util)
diff --git a/docs/index.rst b/docs/index.rst