From be33a5cbf4c8c7afdd547125e1c32f37ee98ef0d Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 4 Oct 2024 15:15:55 -0400 Subject: [PATCH] Fix GitHub source code links for decorated functions --- docs/conf.py | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index db895de..326a8c6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -98,17 +98,26 @@ def linkcode_resolve(domain, info): if module is None or "qiskit_ibm_transpiler" 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: