Link in autodocumentation for recently added code: (#98)

* TTENSOR, HOSVD, TUCKER_ALS, Tensor generators
sandialabs · Apr 27, 2023 · bc24b67 · bc24b67
1 parent 6d26158
commit bc24b67
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 6 deletions.
diff --git a/docs/source/algorithms.rst b/docs/source/algorithms.rst
@@ -5,3 +5,5 @@ Algorithms
 
     cpals.rst
     cpapr.rst
+    hosvd.rst
+    tuckerals.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -79,7 +79,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

diff --git a/docs/source/hosvd.rst b/docs/source/hosvd.rst
@@ -1,2 +1,7 @@
 pyttb.hosvd
-===================
+===================
+
+.. automodule:: pyttb.hosvd
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/sptensor.rst b/docs/source/sptensor.rst
@@ -1,9 +1,9 @@
 pyttb.sptensor
 ----------------------
 
-.. autoclass:: pyttb.sptensor
+.. automodule:: pyttb.sptensor
     :members:
     :special-members:
     :exclude-members: __dict__,__weakref__
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:
diff --git a/docs/source/tensor_classes.rst b/docs/source/tensor_classes.rst
@@ -7,5 +7,6 @@ Tensor Classes
     ktensor.rst
     sptensor.rst
     tensor.rst
+    ttensor.rst
     tenmat.rst
 
diff --git a/docs/source/ttensor.rst b/docs/source/ttensor.rst
@@ -1,2 +1,9 @@
 pyttb.ttensor
-=====================
+--------------------
+
+.. automodule:: pyttb.ttensor
+    :members:
+    :special-members:
+    :exclude-members: __dict__,__weakref__
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/tuckerals.rst b/docs/source/tuckerals.rst
@@ -1,2 +1,7 @@
 pyttb.tucker_als
-========================
+========================
+
+.. automodule:: pyttb.tucker_als
+    :members:
+    :undoc-members:
+    :show-inheritance: