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

Switch to linkcode extension #4410

Merged
merged 6 commits into from
Jan 13, 2025
Merged

Switch to linkcode extension #4410

merged 6 commits into from
Jan 13, 2025

Conversation

ankatiyar
Copy link
Contributor

@ankatiyar ankatiyar commented Jan 10, 2025

Description

Resolve #4174

Development notes

Switched from sphinx.ext.viewcode --> sphinx.ext.linkcode, which required adding a linkcode_resolve() function to the conf.py (code copied from/inspired by other docs that use the extension)

This is what it should look like in the API docs ->

When you click on the "[source]", it should take you to kedro's repo for the code

Screenshot 2025-01-13 at 11 30 55 Screenshot 2025-01-13 at 11 31 05

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

Signed-off-by: Ankita Katiyar <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>
@ankatiyar ankatiyar marked this pull request as ready for review January 13, 2025 11:37
Copy link
Contributor

@ElenaKhaustova ElenaKhaustova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works like a magic 👍

@ElenaKhaustova
Copy link
Contributor

Shall we make the same for Viz/datasets docs?

@merelcht merelcht mentioned this pull request Jan 13, 2025
5 tasks
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finally 😭 Thanks a lot @ankatiyar ! And as @ElenaKhaustova says, let's do the same for all subprojects

@ankatiyar
Copy link
Contributor Author

ankatiyar commented Jan 13, 2025

Finally 😭 Thanks a lot @ankatiyar ! And as @ElenaKhaustova says, let's do the same for all subprojects

I'll do separate PRs and keep the issue open :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace source code with GitHub links
3 participants