Merge pull request #29 from stockeh/add-docs

Convert to using Sphinx for docs
stockeh · Nov 9, 2024 · 525f52a · 525f52a
2 parents 6278d40 + cf41878
commit 525f52a
Show file tree

Hide file tree

Showing 42 changed files with 474 additions and 235 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 <p align="center">
-  <img src="https://github.com/user-attachments/assets/57405cc1-36f9-4848-b507-e8c84c922d11#gh-dark-mode-only" alt="logo">
+  <img src="docs/src/_static/dark-mode-logo.svg#gh-dark-mode-only" alt="logo">
 </p>
 <p align="center">
-  <img src="https://github.com/user-attachments/assets/831cf205-0d56-49ac-8b8d-fc16be370cca#gh-light-mode-only" alt="logo">
+  <img src="docs/src/_static/light-mode-logo.svg#gh-light-mode-only" alt="logo">
 </p>
 
 # 

diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -0,0 +1,50 @@
+################################################################################
+# Primary project setup.                                                       #
+################################################################################
+
+PROJECT_NAME           = "MLX-Optimizers"
+OUTPUT_DIRECTORY       = build
+XML_OUTPUT             = xml
+HTML_OUTPUT            = html
+STRIP_FROM_PATH        = ../
+INPUT                  = ../mlx_optimizers
+FILE_PATTERNS          = *.py
+EXCLUDE_PATTERNS       = */private/*
+CREATE_SUBDIRS         = NO
+FULL_PATH_NAMES        = YES
+RECURSIVE              = YES
+GENERATE_HTML          = YES
+GENERATE_LATEX         = NO
+GENERATE_XML           = YES
+XML_PROGRAMLISTING     = YES
+
+################################################################################
+# Doxygen preprocessor / parser control.                                       #
+################################################################################
+
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = NO
+SKIP_FUNCTION_MACROS   = NO
+
+################################################################################
+# Compound extraction control.                                                 #
+################################################################################
+
+EXTRACT_ALL            = YES
+EXTRACT_PACKAGE        = YES
+EXTRACT_STATIC         = YES
+CASE_SENSE_NAMES       = NO
+
+################################################################################
+# Docstring control / customization.                                           #
+################################################################################
+
+JAVADOC_AUTOBRIEF      = YES
+
+################################################################################
+# Warning suppression.                                                         #
+################################################################################
+
+QUIET                  = YES
+WARN_IF_UNDOCUMENTED   = NO
diff --git a/docs/Makefile b/docs/Makefile
@@ -3,9 +3,9 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?= -W
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = src
 BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".

diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/media/rosenbrock_all.png b/docs/media/rosenbrock_all.png
diff --git a/docs/source/CHANGELOG.md b/docs/source/CHANGELOG.md
diff --git a/docs/source/CONTRIBUTING.md b/docs/source/CONTRIBUTING.md
diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css
diff --git a/docs/source/_static/favicon.ico b/docs/source/_static/favicon.ico
diff --git a/docs/source/conf.py b/docs/source/conf.py
diff --git a/docs/source/index.md b/docs/source/index.md
diff --git a/docs/source/installation.md b/docs/source/installation.md
diff --git a/docs/source/overview.md b/docs/source/overview.md
diff --git a/docs/src/CHANGELOG.md b/docs/src/CHANGELOG.md
@@ -0,0 +1 @@
+../../CHANGELOG.md
diff --git a/docs/src/CONTRIBUTING.md b/docs/src/CONTRIBUTING.md
@@ -0,0 +1 @@
+../../.github/CONTRIBUTING.md
diff --git a/docs/src/_autosummary/mlx_optimizers.ADOPT.rst b/docs/src/_autosummary/mlx_optimizers.ADOPT.rst
@@ -0,0 +1,31 @@
+mlx\_optimizers.ADOPT
+=====================
+
+.. currentmodule:: mlx_optimizers
+
+.. autoclass:: ADOPT
+
+
+
+
+
+
+
+    .. image:: mlx_optimizers/../../_static/media/rosenbrock_ADOPT.png
+        :align: center
+
+
+
+
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+         ~ADOPT.__init__
+         ~ADOPT.apply_single
+         ~ADOPT.init_single
+
+
diff --git a/docs/src/_autosummary/mlx_optimizers.DiffGrad.rst b/docs/src/_autosummary/mlx_optimizers.DiffGrad.rst
@@ -0,0 +1,31 @@
+mlx\_optimizers.DiffGrad
+========================
+
+.. currentmodule:: mlx_optimizers
+
+.. autoclass:: DiffGrad
+
+
+
+
+
+
+
+    .. image:: mlx_optimizers/../../_static/media/rosenbrock_DiffGrad.png
+        :align: center
+
+
+
+
+
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+         ~DiffGrad.__init__
+         ~DiffGrad.apply_single
+         ~DiffGrad.init_single
+
+