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
[DOC] Workaround for sphinx warning reference target not found for 2 scikit-learn (v1.3) classes #3804
Conversation
👋 @ymzayek Thanks for creating a PR! Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft. Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.
For new features:
For bug fixes:
We will review it as quick as possible, feel free to ping us with questions if needed. |
Codecov Report
@@ Coverage Diff @@
## main #3804 +/- ##
=======================================
Coverage 91.52% 91.53%
=======================================
Files 133 133
Lines 15561 15575 +14
Branches 3229 3233 +4
=======================================
+ Hits 14242 14256 +14
Misses 772 772
Partials 547 547
Flags with carried forward coverage won't be shown. Click here to find out more. see 8 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
You can resolve the problem by using intersphinx to make the link work as done there: https://github.com/microsoft/LightGBM/pull/5956/files You can see the scikit-learn/scikit-learn#26747 (comment) for more details. |
I am pretty sure we are already using intersphinx: 🤷🏾♂️ |
@glemaitre we already use it and it works correctly as can be seen in our stable docs based on sklearn v1.2 e.g. see link to Pipeline class here: https://nilearn.github.io/stable/modules/generated/nilearn.regions.RegionExtractor.html#nilearn.regions.RegionExtractor.set_params. That's why I suspect it comes from the source code particularly from the file referenced in my comment in scikit-learn/scikit-learn#26761. Maybe just a syntax thing? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thx.
See #3800. See also scikit-learn/scikit-learn#26761
This warning fails the full doc build
Changes proposed in this pull request: