Merge pull request #206 from kozistr/docs/mkdocs

[Docs] Migrate to mkdocs

Author: kozistr

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

docs/.readthedocs.yaml

@@ -5,8 +5,9 @@ build:
   tools:
     python: "3.11"
 
-sphinx:
-   configuration: docs/conf.py
+mkdocs:
+  configuration: mkdocs.yml
+  fail_on_warning: false
 
 python:
    install:

docs/Makefile

@@ -0,0 +1,5 @@
+# Base
+
+::: pytorch_optimizer.base.optimizer.BaseOptimizer
+    :docstring:
+    :members:

docs/base.md

@@ -0,0 +1,11 @@
+# Welcome to pytorch-optimizer
+
+[base docs](base.md)
+
+[optimizer docs](optimizer.md)
+
+[lr_scheduler docs](lr_scheduler.md)
+
+[loss docs](loss.md)
+
+[util docs](util.md)

docs/base_api.rst

@@ -0,0 +1,55 @@
+# Loss Function
+
+::: pytorch_optimizer.loss.bi_tempered.bi_tempered_logistic_loss
+    :docstring:
+
+::: pytorch_optimizer.BiTemperedLogisticLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.BinaryBiTemperedLogisticLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.BCELoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.SoftF1Loss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.FocalLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.FocalCosineLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.BCEFocalLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.FocalTverskyLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.loss.jaccard.soft_jaccard_score
+    :docstring:
+
+::: pytorch_optimizer.JaccardLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.LDAMLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.LovaszHingeLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.TverskyLoss
+    :docstring:
+    :members: