diff --git a/docs/base.md b/docs/base.md new file mode 100644 index 00000000..a888aab8 --- /dev/null +++ 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 index 15fc3ee7..1760dd2f 100644 --- 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 deleted file mode 100644 index e187be5a..00000000 --- a/docs/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. pytorch-optimizers documentation master file, created by - sphinx-quickstart on Wed Sep 22 18:07:06 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to pytorch-optimizers documentation! -============================================ - -.. include:: ../README.rst - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - -Contents --------- - -.. toctree:: - :maxdepth: 2 - - base_api - optimizer_api - scheduler_api - loss_api - util_api - -Indices and tables -================== - -* :ref:`search`