Merge pull request #209 from kozistr/docs/configs

[Docs] Update documentation

Author: kozistr

docs/.readthedocs.yaml

@@ -11,4 +11,4 @@ mkdocs:
 
 python:
    install:
-   - requirements: docs/requirements.txt
+   - requirements: requirements-docs.txt

docs/javascripts/tables.js

@@ -0,0 +1,6 @@
+app.location$.subscribe(function() {
+  var tables = document.querySelectorAll("article table")
+  tables.forEach(function(table) {
+    new Tablesort(table)
+  })
+})

mkdocs.yml

@@ -1,9 +1,25 @@
 site_name: pytorch-optimizer
+site_description: 'optimizer & lr scheduler & loss function collections in PyTorch'
+repo_name: 'kozistr/pytorch-optimizer'
+repo_url: 'https://github.com/kozistr/pytorch_optimizer'
+nav:
+  - index.md
+  - base.md
+  - optimizer.md
+  - lr_scheduler.md
+  - loss.md
+  - util.md
+  - ... | changelogs/*.md
 theme:
   name: material
   highlightjs: true
+extra_javascript:
+  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
+  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
+  - javascripts/tables.js
 plugins:
   - search
+  - awesome-pages
   - mkdocstrings:
       handlers:
         python:
@@ -19,12 +35,22 @@ plugins:
             docstring_style: sphinx
 markdown_extensions:
   - admonition
-  - pymdownx.critic
+  - pymdownx.arithmatex
+  - pymdownx.betterem:
+      smart_enable: all
   - pymdownx.caret
-  - pymdownx.keys
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_generator: !!python/name:pymdownx.emoji.to_svg
+  - pymdownx.inlinehilite
+  - pymdownx.magiclink
   - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences
+  - pymdownx.tasklist:
+      custom_checkbox: true
   - pymdownx.tilde
-  - pymdownx.arithmatex:
-      generic: true
+  - mdx_truly_sane_lists
   - markdown_include.include:
       base_path: .

docs/requirements.txt renamed to requirements-docs.txt

@@ -3,7 +3,9 @@
 numpy
 torch==2.0.1
 mkdocs==1.5.2
-mkdocs-material==9.2.8
+mkdocs-material==9.3.1
 pymdown-extensions==10.3
-mkdocstrings-python==1.6.2
+mkdocstrings-python==1.7.0
 markdown-include==0.8.1
+mdx_truly_sane_lists==1.3
+mkdocs-awesome-pages-plugin==2.9.2