Skip to content

docs: point dependency_links deprecation page to modern direct URL dependencies - #5312

Open
CAOShurong wants to merge 1 commit into
pypa:mainfrom
CAOShurong:codex/docs-dependency-links-pointer
Open

docs: point dependency_links deprecation page to modern direct URL dependencies#5312
CAOShurong wants to merge 1 commit into
pypa:mainfrom
CAOShurong:codex/docs-dependency-links-pointer

Conversation

@CAOShurong

Copy link
Copy Markdown

Fixes #4859.

Summary

The dependency_links deprecation page warns that pip dropped support in 19.0 (2019), but then continues with ~80 lines of working-looking setup() / setup.cfg recipes without ever telling the reader what to do instead. This is exactly the confusion reported in #4859: a reader lands on this page needing "a link to a GitHub repo as a dependency" and leaves without a modern answer.

Change

Docs-only, no code:

  1. Extend the warning box to state explicitly that everything below is historical and no longer works with current pip/setuptools.
  2. Point readers to the modern replacement: PEP 508 direct references (name @ URL) declared in dependencies, linking to the existing "Direct URL dependencies" section of the user guide (:doc: reference + section name; docs/conf.py does not enable autosectionlabel, so a bare section anchor :ref: is not available).

Verification

  • Sphinx HTML build of the modified page in an isolated app passes clean (roles :pep:/:doc: resolve; no new warnings).
  • The referenced target exists at docs/userguide/dependency_management.rst L212 ("Direct URL dependencies") and documents both git+https://... and wheel-URL forms.

…pendencies

The dependency_links deprecation page warned that pip dropped support in
19.0 but gave readers no path forward. Add an explicit pointer to the
PEP 508 direct-reference syntax and the 'Direct URL dependencies' section
of the dependency management guide, and mark the rest of the page as
historical.

Fixes pypa#4859

Signed-off-by: Shurong Cao <170531907+CAOShurong@users.noreply.github.com>
@mergify

mergify Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

@Avasam

Avasam commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Also done in #5305

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.

[Docs] dependency_links removal documentation

2 participants