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

[DOC] Workaround for sphinx warning reference target not found for 2 scikit-learn (v1.3) classes #3804

Merged
merged 1 commit into from Jul 5, 2023

Conversation

ymzayek
Copy link
Member

@ymzayek ymzayek commented Jul 4, 2023

See #3800. See also scikit-learn/scikit-learn#26761

This warning fails the full doc build

Changes proposed in this pull request:

  • Add nitpicky option to conf.py
  • Add reference targets to ignore

@github-actions
Copy link
Contributor

github-actions bot commented Jul 4, 2023

👋 @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.

  • PR has an interpretable title.
  • PR links to Github issue with mention Closes #XXXX (see our documentation on PR structure)
  • Code is PEP8-compliant (see our documentation on coding style)
  • Changelog or what's new entry in doc/changes/latest.rst (see our documentation on PR structure)

For new features:

  • There is at least one unit test per new function / class (see our documentation on testing)
  • The new feature is demoed in at least one relevant example.

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

We will review it as quick as possible, feel free to ping us with questions if needed.

@codecov
Copy link

codecov bot commented Jul 4, 2023

Codecov Report

Merging #3804 (17154f5) into main (186845c) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           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           
Flag Coverage Δ
macos-latest_3.10 91.45% <ø> (?)
macos-latest_3.11 91.45% <ø> (?)
macos-latest_3.8 91.41% <ø> (?)
macos-latest_3.9 91.41% <ø> (?)
ubuntu-latest_3.10 91.45% <ø> (?)
ubuntu-latest_3.11 91.45% <ø> (+<0.01%) ⬆️
ubuntu-latest_3.8 91.41% <ø> (?)
ubuntu-latest_3.9 91.41% <ø> (+<0.01%) ⬆️
windows-latest_3.10 91.39% <ø> (?)
windows-latest_3.11 91.39% <ø> (+<0.01%) ⬆️
windows-latest_3.8 91.36% <ø> (+<0.01%) ⬆️
windows-latest_3.9 91.36% <ø> (+<0.01%) ⬆️

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

@glemaitre
Copy link
Contributor

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.

@Remi-Gau
Copy link
Collaborator

Remi-Gau commented Jul 4, 2023

@glemaitre

I am pretty sure we are already using intersphinx: 🤷🏾‍♂️

@ymzayek
Copy link
Member Author

ymzayek commented Jul 5, 2023

@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?

Copy link
Member

@bthirion bthirion left a comment

Choose a reason for hiding this comment

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

LGTM, thx.

@Remi-Gau Remi-Gau merged commit 8a7a80c into nilearn:main Jul 5, 2023
28 checks passed
@ymzayek ymzayek deleted the fix-sphinx-target branch July 5, 2023 08:11
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.

None yet

4 participants