Skip to content

Commit bc24b67

Browse files
authored
Link in autodocumentation for recently added code: (#98)
* TTENSOR, HOSVD, TUCKER_ALS, Tensor generators
1 parent 6d26158 commit bc24b67

File tree

7 files changed

+26
-6
lines changed

7 files changed

+26
-6
lines changed

docs/source/algorithms.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ Algorithms
55

66
cpals.rst
77
cpapr.rst
8+
hosvd.rst
9+
tuckerals.rst

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
#
8080
# This is also used if you do content translation via gettext catalogs.
8181
# Usually you set "language" from the command line for these cases.
82-
language = None
82+
language = "en"
8383

8484
# List of patterns, relative to source directory, that match files and
8585
# directories to ignore when looking for source files.

docs/source/hosvd.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
pyttb.hosvd
2-
===================
2+
===================
3+
4+
.. automodule:: pyttb.hosvd
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/source/sptensor.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
pyttb.sptensor
22
----------------------
33

4-
.. autoclass:: pyttb.sptensor
4+
.. automodule:: pyttb.sptensor
55
:members:
66
:special-members:
77
:exclude-members: __dict__,__weakref__
88
:undoc-members:
9-
:show-inheritance:
9+
:show-inheritance:

docs/source/tensor_classes.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Tensor Classes
77
ktensor.rst
88
sptensor.rst
99
tensor.rst
10+
ttensor.rst
1011
tenmat.rst
1112

docs/source/ttensor.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,9 @@
11
pyttb.ttensor
2-
=====================
2+
--------------------
3+
4+
.. automodule:: pyttb.ttensor
5+
:members:
6+
:special-members:
7+
:exclude-members: __dict__,__weakref__
8+
:undoc-members:
9+
:show-inheritance:

docs/source/tuckerals.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
pyttb.tucker_als
2-
========================
2+
========================
3+
4+
.. automodule:: pyttb.tucker_als
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

0 commit comments

Comments
 (0)