diff --git a/doc/_templates/autosummary/class_no_inherited_members.rst b/doc/_templates/autosummary/class_no_inherited_members.rst new file mode 100644 index 00000000000..05dd226dd6a --- /dev/null +++ b/doc/_templates/autosummary/class_no_inherited_members.rst @@ -0,0 +1,13 @@ +{{ fullname | escape | underline}} + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + :special-members: __contains__,__getitem__,__iter__,__len__,__add__,__sub__,__mul__,__div__,__neg__ + :members: + :no-inherited-members: + +.. _sphx_glr_backreferences_{{ fullname }}: + +.. minigallery:: {{ fullname }} + :add-heading: diff --git a/doc/conf.py b/doc/conf.py index d703d4da57d..c3fe505137f 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -171,6 +171,10 @@ # Define what extra methods numpydoc will document docscrape.ClassDoc.extra_public_methods = mne.utils._doc_special_members numpydoc_class_members_toctree = False +numpydoc_show_inherited_class_members = { + 'mne.SourceSpaces': False, + 'mne.Forward': False, +} numpydoc_attributes_as_param_list = True numpydoc_xref_param_type = True numpydoc_xref_aliases = { diff --git a/doc/forward.rst b/doc/forward.rst index 5cf2165bd5a..7e554195aa6 100644 --- a/doc/forward.rst +++ b/doc/forward.rst @@ -6,9 +6,14 @@ Forward Modeling .. autosummary:: :toctree: generated/ + :template: autosummary/class_no_inherited_members.rst Forward SourceSpaces + +.. autosummary:: + :toctree: generated/ + add_source_space_distances apply_forward apply_forward_raw