Skip to content

Commit f705be6

Browse files
committed
docs: add autoattributes
1 parent 9ec1de8 commit f705be6

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

doc/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@
4848
# pymbolic
4949
"ArithmeticExpression": "obj:pymbolic.ArithmeticExpression",
5050
"Expression": "obj:pymbolic.typing.Expression",
51+
# loopy
52+
"Assignment": "class:loopy.kernel.instruction.Assignment",
53+
"CallInstruction": "class:loopy.kernel.instruction.CallInstruction",
5154
# arraycontext
5255
"Array": "obj:arraycontext.Array",
5356
# boxtree

sumpy/expansion/__init__.py

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,9 @@
8080
@dataclass(frozen=True)
8181
class ExpansionBase(ABC):
8282
"""
83-
.. attribute:: kernel
84-
.. attribute:: order
85-
.. attribute:: use_rscale
83+
.. autoattribute:: kernel
84+
.. autoattribute:: order
85+
.. autoattribute:: use_rscale
8686
8787
.. automethod:: get_coefficient_identifiers
8888
.. automethod:: coefficients_from_source
@@ -142,7 +142,7 @@ def get_source_args(self) -> Sequence[KernelArgument]:
142142

143143
@abstractmethod
144144
def get_storage_index(self, mi: MultiIndex) -> int:
145-
...
145+
pass
146146

147147
@abstractmethod
148148
def get_coefficient_identifiers(self) -> Sequence[MultiIndex]:
@@ -255,16 +255,18 @@ def __len__(self) -> int:
255255
@dataclass(frozen=True)
256256
class ExpansionTermsWrangler(ABC):
257257
"""
258-
.. attribute:: order
259-
.. attribute:: dim
260-
.. attribute:: max_mi
258+
.. autoattribute:: order
259+
.. autoattribute:: dim
260+
.. autoattribute:: max_mi
261261
262+
.. automethod:: copy
262263
.. automethod:: get_coefficient_identifiers
263264
.. automethod:: get_full_kernel_derivatives_from_stored
264265
.. automethod:: get_stored_mpole_coefficients_from_full
265266
266-
. automethod:: get_full_coefficient_identifiers
267+
.. automethod:: get_full_coefficient_identifiers
267268
"""
269+
268270
order: int
269271
dim: int
270272
max_mi: MultiIndex | None

0 commit comments

Comments
 (0)