Add auto-generated API docs

README.md

@@ -21,6 +21,7 @@ pytest src/metrax
 Develop the docs locally:
 
 ```
+pip install -r ./docs/requirements.txt
 sphinx-build ./docs /tmp/metrax_docs
 python -m http.server --directory /tmp/metrax_docs
 ```

docs/conf.py

@@ -15,15 +15,21 @@
 """Configuration file for the Sphinx documentation builder."""
 
 import sphinx_rtd_theme
+import os
+import sys
+
+# Import local version of metrax.
+sys.path.insert(0, os.path.abspath('../src'))
+print('DEBUG: PATH', sys.path)
 
 # -- Project information
 
 project = 'metrax'
 copyright = '2025, The metrax Authors'
 author = 'The metrax Authors'
 
-release = '0.0.2'
-version = '0.0.2'
+release = ''
+version = ''
 
 
 # -- General configuration
@@ -34,6 +40,8 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.napoleon',
     'sphinx_rtd_theme',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
 ]
 
 intersphinx_mapping = {
@@ -50,3 +58,15 @@
 
 # -- Options for EPUB output
 epub_show_urls = 'footnote'
+
+
+# -- Extension configuration
+
+autodoc_member_order = 'bysource'
+
+autodoc_default_options = {
+    'members': None,
+    'undoc-members': True,
+    'show-inheritance': True,
+    'special-members': '__call__, __init__',
+}

docs/index.rst

@@ -3,6 +3,38 @@ metrax Documentation
 
 **metrax** provides common evaluation metric implementations for JAX.
 
-.. note::
+Getting Started
+---------------
 
-   This project is under active development.
+Metrics are based on `clu.Metric`.
+
+.. code-block::
+
+    # Run model:
+    y_true, y_pred = model(inputs)
+
+    # Create metric class:
+    metric = metrics.Precision.from_model_output(
+        predictions=y_pred,
+        labels=y_true,
+    )
+
+    # Update metric with new inputs:
+    metric = metric.merge(
+        metrics.Precision.from_model_output(
+            predictions=y_pred,
+            labels=y_true,
+        )
+    )
+
+    # Get result:
+    result = metric.compute()
+
+
+Metrax API
+==========
+
+.. toctree::
+   :maxdepth: 2
+
+   metrax API <metrax>

docs/metrax.rst

@@ -0,0 +1,4 @@
+metrax
+======
+
+.. automodule:: metrax

docs/requirements.txt

@@ -1 +1,3 @@
 sphinx-rtd-theme==1.3.0rc1
+clu==0.0.12
+scikit-learn==1.6.1