DOC: make an API reference

lucascolley · lucascolley · commit 550331d2c50d · 2024-09-20T18:21:09.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -70,6 +70,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/generated/
 
 # PyBuilder
 .pybuilder/
diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -0,0 +1,10 @@
+# API Reference
+
+```{eval-rst}
+.. currentmodule:: array_api_extra
+.. autosummary::
+    :nosignatures:
+    :toctree: generated
+
+    atleast_nd
+```
diff --git a/docs/conf.py b/docs/conf.py
@@ -9,6 +9,7 @@
 extensions = [
     "myst_parser",
     "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
diff --git a/docs/index.md b/docs/index.md
@@ -3,15 +3,9 @@
 ```{toctree}
 :maxdepth: 2
 :hidden:
-
+api-reference.md
 ```
 
 ```{include} ../README.md
 :start-after: <!-- SPHINX-START -->
 ```
-
-## Indices and tables
-
-- {ref}`genindex`
-- {ref}`modindex`
-- {ref}`search`
