Cpp docs (#1036)

* start of C++ docs * fix stream doc * only include ops for now
2025-10-19 08:38:09 +08:00 · 2024-04-26 12:56:05 -07:00
parent 82463e9938
commit 5bfe89bdb1
9 changed files with 87 additions and 20 deletions
--- a/docs/src/conf.py
+++ b/docs/src/conf.py
@@ -22,6 +22,7 @@ extensions = [
    "sphinx.ext.autosummary",
    "sphinx.ext.intersphinx",
    "sphinx.ext.napoleon",
+    "breathe",
 ]

 python_use_unqualified_type_names = True
@@ -33,6 +34,9 @@ intersphinx_mapping = {
    "numpy": ("https://numpy.org/doc/stable/", None),
 }

+breathe_projects = {"mlx": "../build/xml"}
+breathe_default_project = "mlx"
+
 templates_path = ["_templates"]
 html_static_path = ["_static"]
 source_suffix = ".rst"
--- a/docs/src/cpp/ops.rst
+++ b/docs/src/cpp/ops.rst
@@ -3,4 +3,5 @@
 Operations
 ==========

-
+.. doxygengroup:: ops
+   :content-only: