update: mkdocs

kozistr · Sep 10, 2023 · e3d7297 · e3d7297
1 parent 57cb8a6
commit e3d7297
Show file tree

Hide file tree

Showing 11 changed files with 62 additions and 136 deletions.
diff --git a/Makefile b/Makefile
@@ -20,4 +20,4 @@ requirements:
 	python -m poetry export -f requirements.txt --output requirements-dev.txt --without-hashes --with dev
 
 docs:
-	make -C docs html
+	mkdocs serve
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,9 @@
+# Welcome to pytorch-optimizer
+
+[optimizer docs](optimizer)
+
+[lr_scheduler docs](lr_scheduler)
+
+[loss docs](loss)
+
+[util docs](util)
diff --git a/docs/loss.md b/docs/loss.md
@@ -0,0 +1 @@
+# Loss
diff --git a/docs/lr_scheduler.md b/docs/lr_scheduler.md
@@ -0,0 +1 @@
+# Learning Rate Scheduler
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/optimizer.md b/docs/optimizer.md
@@ -0,0 +1,13 @@
+# Optimizers
+
+::: pytorch_optimizer.A2Grad
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.AdaBelief
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.AdaBound
+    :docstring:
+    :members:
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -4,3 +4,6 @@ numpy
 torch==2.0.1
 mkdocs==1.5.2
 mkdocs-material==9.2.8
+pymdown-extensions==10.3
+mkdocstrings-python==1.6.2
+markdown-include==0.8.1
diff --git a/docs/util.md b/docs/util.md
@@ -0,0 +1 @@
+# Util
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,33 @@
+site_name: pytorch-optimizer
+theme:
+  name: material
+  highlightjs: true
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_root_heading: true
+            show_root_full_path: false
+            show_root_members_full_path: false
+            show_symbol_type_toc: true
+            allow_inspection: true
+            show_bases: true
+            show_source: true
+            docstring_style: sphinx
+markdown_extensions:
+  - admonition
+  - pymdownx.critic
+  - pymdownx.caret
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.tilde
+  - pymdownx.arithmatex:
+      generic: true
+  - markdown_include.include:
+      base_path: .
+
+extra_javascript:
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js