Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC] Improve docstring rendering for typed experimental surface module #4049

Merged
merged 2 commits into from
Nov 7, 2023
Merged

[DOC] Improve docstring rendering for typed experimental surface module #4049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de6d168
Correct linking
Oct 12, 2023
c821277
Fix note
Oct 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 6 additions & 2 deletions doc/modules/experimental.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,12 @@
:no-members:
:no-inherited-members:

nilearn.experimental.surface
----------------------------
:mod:`nilearn.experimental.surface`
-----------------------------------

.. automodule:: nilearn.experimental.surface
:no-members:
:no-inherited-members:
Comment on lines +13 to +15
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is actually needed to correctly reference the module and wasn't causing the :noindex: error in #4017


**Classes**:

Expand Down
7 changes: 5 additions & 2 deletions doc/sphinxext/github_link.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,12 @@ def _linkcode_resolve(domain, info, package, url_fmt, revision):

class_name = info["fullname"].split(".")[0]
module = __import__(info["module"], fromlist=[class_name])
if info["module"] == "nilearn.experimental.surface":
# For typed parameters, this will try to get uninitialized attributes
# and fail
try:
obj = attrgetter(info["fullname"])(module)
except AttributeError:
return
obj = attrgetter(info["fullname"])(module)

# Unwrap the object to get the correct source
# file in case that is wrapped by a decorator
Expand Down