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

docs(datasets): Move to linkcode extension #985

Merged
merged 1 commit into from
Jan 13, 2025
Merged

docs(datasets): Move to linkcode extension #985

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion kedro-datasets/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
from __future__ import annotations

import importlib
import inspect
import os
import re
import sys
from inspect import getmembers, isclass, isfunction
Expand All @@ -22,6 +24,8 @@
from click import secho, style
from kedro import __version__ as release

import kedro_datasets

# -- Project information -----------------------------------------------------

project = "kedro-datasets"
Expand All @@ -47,7 +51,7 @@
"sphinx_autodoc_typehints",
"sphinx.ext.doctest",
"sphinx.ext.ifconfig",
"sphinx.ext.viewcode",
"sphinx.ext.linkcode",
"sphinxcontrib.jquery",
"sphinx_copybutton",
"myst_parser",
Expand Down Expand Up @@ -452,3 +456,25 @@ def setup(app):
user_agent = "Mozilla/5.0 (X11; Linux x86_64; rv:99.0) Gecko/20100101 Firefox/99.0"

myst_heading_anchors = 5

def linkcode_resolve(domain, info):
"""Resolve a GitHub URL corresponding to a Python object."""
if domain != 'py':
return None

try:
mod = sys.modules[info['module']]
obj = mod
for attr in info['fullname'].split('.'):
obj = getattr(obj, attr)
obj = inspect.unwrap(obj)

filename = inspect.getsourcefile(obj)
source, lineno = inspect.getsourcelines(obj)
relpath = os.path.relpath(filename, start=os.path.dirname(
kedro_datasets.__file__))

return f'https://github.com/kedro-org/kedro-plugins/blob/main/kedro-datasets/kedro_datasets/{relpath}#L{lineno}#L{lineno + len(source) - 1}'

except (KeyError, ImportError, AttributeError, TypeError, OSError, ValueError):
return None
Loading