-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Remove 'pip search' command #10431
Remove 'pip search' command #10431
Conversation
:maxdepth: 1 | ||
:caption: Package Index information | ||
|
||
pip_search |
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.
I wonder if this would trigger the orphan page warning. (Not sure how to avoid it if so.) Is the cli/pip_search
page currently mentioned anywhere in the documentation?
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.
Yes, it triggers an orphan warning. It can be silenced by adding :orphan:
at the top of the page.
It's only referenced in main
at:
- https://github.com/pypa/pip/blob/b1a8539c6a6cf915ba10890c3dee847861644f71/docs/html/cli/index.md
- https://pip.pypa.io/en/stable/cli/
And the redirect at:
- https://github.com/pypa/pip/blob/b1a8539c6a6cf915ba10890c3dee847861644f71/docs/html/reference/pip_search.rst
- https://pip.pypa.io/en/stable/reference/pip_search/
Should :orhpan:
be added? Or the pages removed completely?
Relatedly, looks like a tox -e docs
job is missing from the CI, there's another warning that has slipped through:
Warning, treated as error:
/Users/hugo/github/pip/docs/html/user_guide.rst:1011:undefined label: dependency resolution backtracking
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.
@pradyunsg Could we add a redirect to pip index
?
I feel we can remove the page altogether and put a banner on top of the pip index
page to tell users pip search
has been removed and this is its replacement.
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.
From my point of view, adding :orphan:
should be ok for the pip search
docs failure. Not sure if we should remove the page by now, I would personally prefer a removal a few releases after. A redirection to pip index
sounds a good idea to me.
Anyone else has thoughts about this?
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.
Any update on this?
Rebasing should fix the docs failure. |
This comment has been minimized.
This comment has been minimized.
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.
@hugovk Can you please rebase (or recreate, maybe) this PR?
Co-authored-by: Eric Engestrom <[email protected]>
@DiddiLeija Rebased! And please see #10431 (comment), awaiting a decision how to proceed to fix the docs. |
Sure, I'm aware of that. |
Closing, re: #5216 (comment) |
Thanks for filing this PR @hugovk! Much appreciated! |
You're very welcome! |
Fixes #5216.