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.

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

Move to linkcode extension on docs #2239

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .github/workflows/docs-language-linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,5 @@ jobs:
- uses: actions/checkout@v4
- uses: errata-ai/vale-action@reviewdog
with:
reporter: github-pr-check
reporter: github-pr-check
version: 3.9.2 # temp
27 changes: 25 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,18 @@
from __future__ import annotations

import importlib
import inspect
import os
import re
import sys
from inspect import getmembers, isclass, isfunction
from pathlib import Path

from click import secho, style

from kedro_viz import __version__ as release

import kedro_viz

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

project = "kedro-viz"
Expand Down Expand Up @@ -90,4 +92,25 @@ def _override_permalinks_icon(app):

def setup(app):
app.connect("builder-inited", _override_permalinks_icon)


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_viz.__file__))

return f'https://github.com/kedro-org/kedro-viz/tree/main/package/{relpath}#L{lineno}#L{lineno + len(source) - 1}'

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