link to github source w/ line number?

[dzheng256]

Is it possible to use https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html to generate a github link including the specific line numbers for each function? Currently I've got it working more or less, but every function links to the github page for that module's source. I'm wondering if it is possible to have autoapi figure out the corresponding line in the file so I can include that in the github link.

Essentially in

def linkcode_resolve(domain, info):
    if domain != 'py':
        return None
    if not info['module']:
        return None
    filename = info['module'].replace('.', '/')
    return "https://somesite/sourcerepo/%s.py" % filename

which is the example from the above link, I guess info would have to include the line numbering

Thanks!

[AWhetter]

The viewcode support has to do something similar. You should be able to adapt what it does to work for the linkcode extension:

sphinx-autoapi/autoapi/extension.py

Lines 245 to 249 in b52378f

	locations[full_name] = (
	type_,
	obj.obj["from_line_no"],
	obj.obj["to_line_no"],
	)

What it does isn't exactly part of the public API of AutoAPI but it'll do what you want.
Let me know how you get on.

[aaugustin]

In case that helps, I implemented a version this here:

https://github.com/aaugustin/websockets/blob/main/docs/conf.py#L61-L105

This implementation supports functions, classes, and methods, which is all I care about here.

[ArmageddonKnight]

aaugustin 's solution is pretty elegent. It is just the link appears to be out-of-date due to code changes. The permalink is here: https://github.com/aaugustin/websockets/blob/778a1ca6936ac67e7a3fe1bbe585db2eafeaa515/docs/conf.py#L100-L134

[kddubey]

@aaugustin's solution worked great! I just had to add that the object should be unwrapped, which I learned from sklearn here.

Add

obj = inspect.unwrap(obj)

right before getting the object's sourcefile

Edit: a hack I had to for my directory structure was

file = file.lstrip('../')

right before returning. I identified the issue by inspecting the source for the [source] link, which was missing the branch name 'main'