DOC Fix "Duplicate labels" & "Duplicate .. target" sphinx warn#14931
DOC Fix "Duplicate labels" & "Duplicate .. target" sphinx warn#14931rth merged 6 commits intoscikit-learn:masterfrom
Conversation
| gradient boosting trees, namely :class:`HistGradientBoostingClassifier` | ||
| and :class:`HistGradientBoostingRegressor`, inspired by | ||
| `LightGBM <https://github.com/Microsoft/LightGBM>`_. | ||
| `LightGBM <https://github.com/Microsoft/LightGBM>`__. |
There was a problem hiding this comment.
I did not know double underscores were needed for inline links. Is this a new-ish syntax or has it always been this way? Anyway the links seem to work in the Circle CI rendered HTML.
There was a problem hiding this comment.
I just read the discussion in sphinx-doc/sphinx#3921. Sorry for the noise.
rth
left a comment
There was a problem hiding this comment.
Thanks @cmarmo!
LGTM as well aside from renaming .rst to .inc. I was not sure why we need to do that? Local text editors (or Github for that matter) will no longer recognise it as rst, so I think that is not ideal.
@rth , I agree, but following sphinx-doc/sphinx#1668 I have to find a way to exclude those two files from the build then... this is one possible solution. |
jnothman
left a comment
There was a problem hiding this comment.
Okay by me except for merge conflicts created in open pull requests
Or we can just accept that this warning will remain. I don't have a strong option about it. We can also merge as is. |
Well ... if you ask me, I'd rather accept the warning. Changing the name of those specific two files will introduce manual maintenance each time you produce a new release. |
Let's do it then. |
…anual maintenance is avoided.
|
There is already some manual maintenance with each release associated with
that what's new inclusion, but yes, the rename would add to that burden.
|
Done :-) |
rth
left a comment
There was a problem hiding this comment.
Minor comment otherwise LGTM.
Test fails because master is broken...
Reference Issues/PRs
Fixes #11533
What does this implement/fix? Explain your changes.
duplicate label coding-guidelinesfixed removing the section coding-guidelines fromcontributing.rst(this was a duplicate of the same section indevelop.rst)duplicate labelin "what's new" sections have been fixed following "WARNING: duplicate label" because of include sphinx-doc/sphinx#1668In addition to that
duplicate explicit target namewarnings are fixed following Duplicate explicit target name errors sphinx-doc/sphinx#3921Any other comments?
whats_new.rst, maybe a symbolic link to (e.g.)last.incandprevious.inccould be also be a solution? ... but then you have to exclude some.rstfrom the build... Anyway this is a fix..