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

Usage of dropdowns are breaking HTML anchor #27408

Closed
glemaitre opened this issue Sep 18, 2023 · 3 comments · Fixed by #27418
Closed

Usage of dropdowns are breaking HTML anchor #27408

glemaitre opened this issue Sep 18, 2023 · 3 comments · Fixed by #27418

Comments

@glemaitre
Copy link
Member

While working on the release 1.3.1, I found the following warning:

- doc/modules/grid_search.rst:611: WARNING: Failed to create a cross reference. A title or caption not found: 'pipeline_nested_parameters'
- sklearn/feature_extraction/text.py:docstring of sklearn.feature_extraction.text.CountVectorizer:59: WARNING: Failed to create a cross reference. A title or caption not found: 'stop_words'
- sklearn/feature_extraction/text.py:docstring of sklearn.feature_extraction.text.HashingVectorizer:86: WARNING: Failed to create a cross reference. A title or caption not found: 'stop_words'
- sklearn/feature_extraction/text.py:docstring of sklearn.feature_extraction.text.TfidfVectorizer:71: WARNING: Failed to create a cross reference. A title or caption not found: 'stop_words' 

After investigation, those warnings a linked to the following pattern:

.. _anchor:

|details-start|
**Title**
|details-split|
Blabla
|details-end|

and when using

:ref:`anchor`

Sphinx failed to create the reference.

We need to investigate and to take into account this issue when reviewing the dropdown menu thingy.

ping @ArturoAmorQ

@github-actions github-actions bot added the Needs Triage Issue requires triage label Sep 18, 2023
@glemaitre
Copy link
Member Author

I assume that one way would be to solve this issue as well: #27127

@glemaitre glemaitre removed the Needs Triage Issue requires triage label Sep 19, 2023
@ogrisel
Copy link
Member

ogrisel commented Sep 19, 2023

We need to investigate and to take into account this issue when reviewing the dropdown menu thingy.

It's not about a drop-down menu but more about collapsed details sections right?

@glemaitre
Copy link
Member Author

It's not about a drop-down menu but more about collapsed details sections right?

Yes. It is just that all PRs are calling this <details> thingy dropdown. We should probably rename those into collapse details that is what it is.

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 a pull request may close this issue.

2 participants