Skip to content

[ENH] Correct broken source links for set_params and get_params in Aeon estimator docs #2754

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Kaustbh
Copy link
Contributor

@Kaustbh Kaustbh commented Apr 18, 2025

Reference Issues/PRs

Fixes: #2752

What does this implement/fix? Explain your changes.

This PR fixes broken "Source" links in the Aeon documentation for the set_params and get_params methods.
Currently, the autogenerated links incorrectly point to sklearn paths such as:

"https://github.com/aeon-toolkit/aeon/blob/main/sklearn/base.py#L255-L297"
which leads to a 404 error, since these methods are inherited from sklearn.BaseEstimator and not directly implemented in Aeon code.

Fixes broken "Source" links by modifying conf.py to exclude non-Aeon paths (e.g., sklearn/base.py) from autogenerated documentation links.

Does your contribution introduce a new dependency? If yes, which one?

Any other comments?

PR checklist

For all contributions
  • I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you after the PR has been merged.
  • The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation or governance.
For new estimators and functions
  • I've added the estimator/function to the online API documentation.
  • (OPTIONAL) I've added myself as a __maintainer__ at the top of relevant files and want to be contacted regarding its maintenance. Unmaintained files may be removed. This is for the full file, and you should not add yourself if you are just making minor changes or do not want to help maintain its contents.
For developers with write access
  • (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I did not find any labels to add based on the title. Please add the [ENH], [MNT], [BUG], [DOC], [REF], [DEP] and/or [GOV] tags to your pull requests titles. For now you can add the labels manually.

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Slack channel if you have any.

PR CI actions

These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

  • Run pre-commit checks for all files
  • Run mypy typecheck tests
  • Run all pytest tests and configurations
  • Run all notebook example tests
  • Run numba-disabled codecov tests
  • Stop automatic pre-commit fixes (always disabled for drafts)
  • Disable numba cache loading
  • Push an empty commit to re-run CI checks

@Kaustbh Kaustbh changed the title Correct broken source links for set_params and get_params in Aeon estimator docs [ENH] Correct broken source links for set_params and get_params in Aeon estimator docs Apr 18, 2025
@MatthewMiddlehurst
Copy link
Member

Please update your PR text, this does not represent the contents of the PR. From what I can tell clicking on the source link in the PR website build this does not actually change anything?

@Kaustbh
Copy link
Contributor Author

Kaustbh commented May 2, 2025

Yes it is not working for the local build, since the generated source link still point to the local sklearn installation,
ex. https://github.com/aeon-toolkit/aeon/blob/myaeon/lib/python3.12/site-packages/sklearn/base.py#L251-L293 because of which the new added condition doesn't work, but I think after deployment, this change should take effect as expected by preventing broken links to external libraries like sklearn.

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.

[ENH] Broken Source Link for set_params and get_params methods
2 participants