docs(integration): add sphinx docs entries

metaopt · Nov 5, 2023 · e72193c · e72193c
1 parent 0341b06
commit e72193c
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 0 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -8,3 +8,7 @@ sphinx-rtd-theme
 sphinxcontrib-bibtex
 sphinx-autodoc-typehints >= 1.19.2
 docutils
+
+jax
+numpy
+torch
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -15,6 +15,11 @@ OpTree: Optimized PyTree Utilities
     typing.rst
     api.rst
 
+.. toctree::
+    :maxdepth: 1
+
+    integration.rst
+
 License
 -------
 

diff --git a/docs/source/integration.rst b/docs/source/integration.rst
@@ -0,0 +1,39 @@
+Integration with Third-Party Libraries
+======================================
+
+Integration for JAX
+-------------------
+
+.. currentmodule:: optree.integration.jax
+
+.. autosummary::
+
+    tree_ravel
+
+.. autofunction:: tree_ravel
+
+------
+
+Integration for NumPy
+---------------------
+
+.. currentmodule:: optree.integration.numpy
+
+.. autosummary::
+
+    tree_ravel
+
+.. autofunction:: tree_ravel
+
+------
+
+Integration for PyTorch
+-----------------------
+
+.. currentmodule:: optree.integration.torch
+
+.. autosummary::
+
+    tree_ravel
+
+.. autofunction:: tree_ravel