Skip to content

Commit f8c2105

Browse files
committed
DOCS: Generate docs for the pyttb_utils. They are mostly internal but it couldn't hurt to have them visible on the web hosted docs.
1 parent 92a2fce commit f8c2105

File tree

3 files changed

+10
-1
lines changed

3 files changed

+10
-1
lines changed

docs/source/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ algorithms for computing low-rank tensor models.
2424

2525
pyttb supports multiple tensor types, including
2626
dense and sparse, as well as specially structured tensors, such as
27-
the Krusal format (stored as factor matrices).
27+
the Kruskal format (stored as factor matrices).
2828

2929
- `Algorithms`_
3030

docs/source/pyttb_utils.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
pyttb.pyttb_utils
2+
--------------------
3+
4+
.. automodule:: pyttb.pyttb_utils
5+
:members:
6+
:special-members:
7+
:exclude-members: __dict__, __weakref__, __slots__, __init__
8+
:show-inheritance:

docs/source/tensor_classes.rst

+1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@ Tensor Classes
1111
tensor.rst
1212
ttensor.rst
1313
tenmat.rst
14+
pyttb_utils.rst
1415

0 commit comments

Comments
 (0)