Skip to content

[py] Fix broken reStructuredText link in docs - #17902

Merged
cgoldberg merged 1 commit into
SeleniumHQ:trunkfrom
cgoldberg:py-fix-link
Aug 11, 2026
Merged

[py] Fix broken reStructuredText link in docs#17902
cgoldberg merged 1 commit into
SeleniumHQ:trunkfrom
cgoldberg:py-fix-link

Conversation

@cgoldberg

@cgoldberg cgoldberg commented Aug 11, 2026

Copy link
Copy Markdown
Member

💥 What does this PR do?

This PR fixes the link syntax for "pip" in the Python API docs. It was using invalid reStructuredText and when rendered to HTML, it generated a broken hyperlink. Since index.rst is used for both the front-page of the API docs and as our pypi.org project page... it has been broken in both places for the past decade or so... better fixed late than never!

🤖 AI assistance

  • No substantial AI assistance used
  • AI assisted (complete below)
    • Tool(s):
    • What was generated:
    • I reviewed all AI output and can explain the change

🔄 Types of changes

  • Docs

@cgoldberg cgoldberg added the C-py Python Bindings label Aug 11, 2026
@cgoldberg cgoldberg self-assigned this Aug 11, 2026
@qodo-code-review

Copy link
Copy Markdown
Contributor

PR Summary by Qodo

Fix broken reStructuredText hyperlink for pip in Python docs

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Fix reStructuredText hyperlink syntax for the pip reference in Python API docs
• Restore correct link rendering in both Sphinx HTML output and the PyPI long description
High-Level Assessment

Current approach is optimal: use the canonical reStructuredText external link form (trailing underscore) so Sphinx and PyPI render the hyperlink correctly.

Files changed (1) +1 / -1

Documentation (1) +1 / -1
index.rstCorrect pip external link markup +1/-1

Correct pip external link markup

• Fixes the pip hyperlink by adding the required trailing underscore for reStructuredText external links. This restores proper HTML rendering and prevents a broken link on both the generated docs front page and the PyPI project page.

py/docs/source/index.rst

@qodo-code-review

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can group findings by type and pick your Finding display, from Minimal to Full

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@cgoldberg
cgoldberg merged commit 80f0c34 into SeleniumHQ:trunk Aug 11, 2026
21 checks passed
@cgoldberg
cgoldberg deleted the py-fix-link branch August 11, 2026 23:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-py Python Bindings

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant