Skip to content

Commit

Permalink
Fix GitHub source code links for decorated functions (#691)
Browse files Browse the repository at this point in the history
* Fix GitHub source code links for decorated functions

* style updates

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
  • Loading branch information
garrison and Eric-Arellano authored Oct 7, 2024
1 parent 28210dc commit 5175a7c
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,17 +163,24 @@ def linkcode_resolve(domain, info):
if module is None or "qiskit_addon_cutting" not in module_name:
return None

def is_valid_code_object(obj):
return inspect.isclass(obj) or inspect.ismethod(obj) or inspect.isfunction(obj)

obj = module
for part in info["fullname"].split("."):
try:
obj = getattr(obj, part)
except AttributeError:
return None
is_valid_code_object = (
inspect.isclass(obj) or inspect.ismethod(obj) or inspect.isfunction(obj)
)
if not is_valid_code_object:
if not is_valid_code_object(obj):
return None

# Unwrap decorators. This requires they used `functools.wrap()`.
while hasattr(obj, "__wrapped__"):
obj = getattr(obj, "__wrapped__")
if not is_valid_code_object(obj):
return None

try:
full_file_name = inspect.getsourcefile(obj)
except TypeError:
Expand Down

0 comments on commit 5175a7c

Please sign in to comment.