Skip to content

CI/DOC: Fix docbuild link warnings #45456

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jan 18, 2022
Merged

CI/DOC: Fix docbuild link warnings #45456

merged 2 commits into from
Jan 18, 2022

Conversation

mroeschke
Copy link
Member

Showing up in recent builds

/home/runner/work/pandas/pandas/doc/source/user_guide/advanced.rst:1263: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/2388' could be replaced by an extlink (try using ':issue:`2388`' instead)
/home/runner/work/pandas/pandas/doc/source/user_guide/cookbook.rst:210: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/2904' could be replaced by an extlink (try using ':issue:`2904`' instead)
/home/runner/work/pandas/pandas/doc/source/user_guide/cookbook.rst:412: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/2995' could be replaced by an extlink (try using ':issue:`2995`' instead)
/home/runner/work/pandas/pandas/doc/source/user_guide/cookbook.rst:927: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/3791' could be replaced by an extlink (try using ':issue:`3791`' instead)
/home/runner/work/pandas/pandas/doc/source/user_guide/cookbook.rst:964: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/2996' could be replaced by an extlink (try using ':issue:`2996`' instead)
/home/runner/work/pandas/pandas/doc/source/user_guide/cookbook.rst:1087: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/2886' could be replaced by an extlink (try using ':issue:`2886`' instead)
/home/runner/work/pandas/pandas/doc/source/user_guide/cookbook.rst:1222: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/19842#issuecomment-892150745' could be replaced by an extlink (try using ':issue:`19842#issuecomment-892150745`' instead)
/home/runner/work/pandas/pandas/doc/source/user_guide/cookbook.rst:1243: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/3032' could be replaced by an extlink (try using ':issue:`3032`' instead)
/home/runner/work/pandas/pandas/doc/source/whatsnew/v0.17.1.rst:52: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/11610' could be replaced by an extlink (try using ':issue:`11610`' instead)

@mroeschke mroeschke added Docs CI Continuous Integration labels Jan 18, 2022
@jbrockmendel
Copy link
Member

Looks like a few more?

/home/runner/work/pandas/pandas/doc/source/development/contributing_codebase.rst:504: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/wiki/Testing' could be replaced by an extlink (try using ':wiki:`Testing`' instead)
/home/runner/work/pandas/pandas/doc/source/development/roadmap.rst:77: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/28095' could be replaced by an extlink (try using ':issue:`28095`' instead)
/home/runner/work/pandas/pandas/doc/source/development/roadmap.rst:131: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/wiki/(Tentative)-rules-for-restructuring-indexing-code' could be replaced by an extlink (try using ':wiki:`(Tentative)-rules-for-restructuring-indexing-code`' instead)
/home/runner/work/pandas/pandas/doc/source/ecosystem.rst:603: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/14468' could be replaced by an extlink (try using ':issue:`14468`' instead)
/home/runner/work/pandas/pandas/doc/source/ecosystem.rst:603: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/26766' could be replaced by an extlink (try using ':issue:`26766`' instead)
/home/runner/work/pandas/pandas/doc/source/ecosystem.rst:603: WARNING: hardcoded link 'https://github.com/pandas-dev/pandas/issues/28142' could be replaced by an extlink (try using ':issue:`28142`' instead)

@jreback jreback added this to the 1.4 milestone Jan 18, 2022
@jreback
Copy link
Contributor

jreback commented Jan 18, 2022

hmm do we need to backport this? (i am going to say yes but i think we might need a different PR for 1.4) as we don't have all doc patches backported

@mroeschke
Copy link
Member Author

Yeah probably needs backporting to 1.4.

Sphinx just released 4.4.0 and this feature triggered this warning sphinx-doc/sphinx#9800

@mroeschke
Copy link
Member Author

We could also pin sphinx <4.4.0 on the 1.4 branch but not sure if that's a messier change.

@jreback
Copy link
Contributor

jreback commented Jan 18, 2022

We could also pin sphinx <4.4.0 on the 1.4 branch but not sure if that's a messier change.
i think that would be ok for 1.4 (whatever is easier)

@jreback jreback merged commit 7b32039 into pandas-dev:main Jan 18, 2022
@lumberbot-app

This comment has been minimized.

Sign in to view
@jreback
Copy link
Contributor

jreback commented Jan 18, 2022

@meeseeksdev backport 1.4.x

@jreback
Copy link
Contributor

jreback commented Jan 18, 2022

@mroeschke do what you can for the 1.4 branch (pin is ok)

@lumberbot-app

This comment has been minimized.

Sign in to view
@mroeschke
Copy link
Member Author

@jreback just did a manual one at #45458

@mroeschke mroeschke deleted the doc/docbuild_links branch January 18, 2022 23:09
@simonjayhawkins simonjayhawkins mentioned this pull request Jan 20, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
CI Continuous Integration Docs
Projects
None yet
Milestone
1.4
Development

Successfully merging this pull request may close these issues.
4 participants
@mroeschke @jbrockmendel @jreback @simonjayhawkins