Skip to content

Commit b172e75

Browse files
tgkoldadmdunla
andauthored
Changing documentation from autoclass to automodule so that it also picks up the related functions that are defined in the same file. Otherwise, these don't appear anywhere in the Python API documentation. Fixes #398. (#399)
Co-authored-by: Danny Dunlavy <dmdunla@sandia.gov>
1 parent 2c1b883 commit b172e75

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/source/sptensor.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
pyttb.sptensor
22
----------------------
33

4-
.. autoclass:: pyttb.sptensor
4+
.. automodule:: pyttb.sptensor
55
:members:
66
:special-members:
77
:exclude-members: __dict__, __weakref__, __slots__, __init__

docs/source/tensor.rst

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

4-
.. autoclass:: pyttb.tensor
4+
.. automodule:: pyttb.tensor
55
:members:
66
:special-members:
7-
:exclude-members: __dict__, __weakref__, __slots__, __init__
7+
:exclude-members: __dict__, __weakref__, __slots__, __init__, mttv_left, mttv_mid, mttv_right, min_split
88
:show-inheritance:

0 commit comments

Comments
 (0)