Include API docs (#16)

object-condensation · Oct 14, 2023 · 03bf5ea · 03bf5ea
1 parent c96f1ad
commit 03bf5ea
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -43,3 +43,5 @@
 ]
 
 always_document_param_types = True
+
+autodoc_mock_imports = ["torch", "tensorflow"]
diff --git a/docs/index.md b/docs/index.md
@@ -10,6 +10,24 @@
 :start-after: <!-- SPHINX-START -->
 ```
 
+## PyTorch implementations
+
+```{eval-rst}
+.. automodule:: object_condensation.pytorch.losses
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## TensorFlow implementations
+
+```{eval-rst}
+.. automodule:: object_condensation.tensorflow.losses
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
 ## Indices and tables
 
 - {ref}`genindex`