Skip to content

Commit 38da777

Browse files
committed
WIP: Clean up Forward and SourceSpaces [skip azp] [skip actions]
1 parent 4351e61 commit 38da777

File tree

4 files changed

+23
-1
lines changed

4 files changed

+23
-1
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{{ fullname | escape | underline}}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. autoclass:: {{ objname }}
6+
:special-members: __contains__,__getitem__,__iter__,__len__,__add__,__sub__,__mul__,__div__,__neg__
7+
:members:
8+
:no-inherited-members:
9+
10+
.. _sphx_glr_backreferences_{{ fullname }}:
11+
12+
.. minigallery:: {{ fullname }}
13+
:add-heading:

doc/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,10 @@
171171
# Define what extra methods numpydoc will document
172172
docscrape.ClassDoc.extra_public_methods = mne.utils._doc_special_members
173173
numpydoc_class_members_toctree = False
174+
numpydoc_show_inherited_class_members = {
175+
'mne.SourceSpaces': False,
176+
'mne.Forward': False,
177+
}
174178
numpydoc_attributes_as_param_list = True
175179
numpydoc_xref_param_type = True
176180
numpydoc_xref_aliases = {

doc/forward.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,14 @@ Forward Modeling
66

77
.. autosummary::
88
:toctree: generated/
9+
:template: autosummary/class_no_inherited_members.rst
910

1011
Forward
1112
SourceSpaces
13+
14+
.. autosummary::
15+
:toctree: generated/
16+
1217
add_source_space_distances
1318
apply_forward
1419
apply_forward_raw

requirements_doc.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# requirements for building docs
22
sphinx!=4.1.0
3-
https://github.com/numpy/numpydoc/archive/main.zip
3+
https://github.com/larsoner/numpydoc/archive/inherited.zip
44
https://github.com/pydata/pydata-sphinx-theme/archive/cf8b113a496eb458587c0778a423e40c7c1aa22d.zip
55
https://github.com/sphinx-gallery/sphinx-gallery/archive/master.zip
66
sphinxcontrib-bibtex>=2.1.2

0 commit comments

Comments
 (0)