docs(api): add missing packages to api docs (#239)

Author: tachyonicClock

docs/api/index.rst

@@ -37,34 +37,24 @@ includes utilities for simulating concept drifts.
     capymoa.datasets
     capymoa.stream
 
-Learners
---------
+Problem Settings
+----------------
 
-These modules implement learners for classification, regression, anomaly detection
-and semi-supervised learning.
+These modules provide classes for defining machine learning problem settings.
 
 ..  autosummary::
     :toctree: modules
-    :caption: Learners
+    :caption: Problem Settings
     :recursive:
 
     capymoa.classifier
     capymoa.regressor
     capymoa.anomaly
     capymoa.ssl
     capymoa.ocl
-
-Drift Detection
----------------
-
-These modules provide classes for detecting concept drifts.
-
-..  autosummary::
-    :toctree: modules
-    :caption: Drift Detection
-    :recursive:
-
     capymoa.drift
+    capymoa.clusterers
+    capymoa.automl
 
 Evaluation
 ----------
@@ -76,7 +66,6 @@ These modules provide classes for evaluating learners.
     :caption: Evaluation
     :recursive:
 
-    capymoa.splitcriteria
     capymoa.evaluation
     capymoa.prediction_interval
 
@@ -90,6 +79,7 @@ These modules provide miscellaneous utilities.
     :caption: Miscellaneous
     :recursive:
 
+    capymoa.splitcriteria
     capymoa.misc
     capymoa.env
 

tasks.py

@@ -9,6 +9,7 @@
 from invoke import task
 from invoke.collection import Collection
 from invoke.context import Context
+from invoke.exceptions import UnexpectedExit
 from pathlib import Path
 from typing import List, Optional
 from subprocess import run
@@ -36,22 +37,30 @@ def all_exist(files: List[str] = None, directories: List[str] = None) -> bool:
 @task()
 def docs_build(ctx: Context, ignore_warnings: bool = False):
     """Build the documentation using Sphinx."""
-    warn = "-W" if not ignore_warnings else ""
-    nitpicky = "-n" if not ignore_warnings else ""
+    cmd = []
+    cmd += "python -m sphinx build".split()
+    cmd += ["--color"]  # color output
+    cmd += ["-b", "html"]  # generate html
+    if not ignore_warnings:
+        cmd += ["-W"]  # warnings as errors
+        cmd += ["-n"]  # nitpicky mode
 
     doc_dir = Path("docs/_build")
     doc_dir.mkdir(exist_ok=True, parents=True)
-    print("Building documentation...")
-
-    ctx.run(
-        f"python -m sphinx build {warn} {nitpicky} --color -E -b html docs {doc_dir}"
-    )
-
-    print("-" * 80)
-    print("Documentation is built and available at:")
-    print(f"  file://{doc_dir.resolve()}/index.html")
-    print("You can copy and paste this URL into your browser.")
-    print("-" * 80)
+    cmd += ["docs", doc_dir.as_posix()]  # add source and output directories
+
+    try:
+        ctx.run(" ".join(cmd), echo=True)
+        print("-" * 80)
+        print("Documentation is built and available at:")
+        print(f"  file://{doc_dir.resolve()}/index.html")
+        print("You can copy and paste this URL into your browser.")
+    except UnexpectedExit:
+        print("-" * 80)
+        print("Documentation build failed. Here are some tips:")
+        print("  - Check the Sphinx output for errors and warnings.")
+        print("  - Try running `invoke docs.clean` to remove cached files.")
+        print("  - Try running with `--ignore-warnings` to ignore warnings.")
 
 
 @task