Skip to content

[py] Fix docs build for RtD #17830

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

Merged
cgoldberg merged 1 commit into from
Jul 28, 2026
Merged

[py] Fix docs build for RtD #17830

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions py/docs/.readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ build:

commands:
- |
set -euo pipefail

@qodo-code-review qodo-code-review Bot Jul 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remediation recommended

1. Readthedocs fix lacks regression test 📘 Rule violation ▣ Testability

The PR fixes a ReadTheDocs build failure by removing shell options but adds no automated regression
test or configuration validation. A future incompatible shell directive could therefore break
documentation builds again without being detected before deployment.
Agent Prompt 
## Issue description
The ReadTheDocs build fix removes `set -euo pipefail` without adding automated coverage for the previously failing build scenario.

## Issue Context
Add a CI check or focused test that validates the ReadTheDocs command block with its actual POSIX shell semantics and fails if unsupported Bash-only options are reintroduced.

## Fix Focus Areas
- py/docs/.readthedocs.yaml[15-17]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

@qodo-code-review qodo-code-review Bot Jul 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

2. Build failures may be masked 🐞 Bug ☼ Reliability

Removing the shell's fail-fast setting allows failed installation, download, extraction, copy, or
generation steps to continue, with the block potentially returning the final sphinx-build status.
A transient TestPyPI or preparation failure can therefore publish stale or incomplete checkout-based
documentation while the build reports success.
Agent Prompt 
## Issue description
Removing `set -euo pipefail` fixes shell incompatibility but also removes explicit failure propagation from the entire multiline build command. Preserve fail-fast behavior using syntax supported by the ReadTheDocs shell, such as portable `set -e` with explicit checks for pipelines, or invoke a supported Bash shell explicitly.

## Issue Context
The command block installs dependencies, fetches and overlays a nightly sdist, generates API inputs and stubs, and finally runs Sphinx. Earlier failures must terminate the build rather than allowing later commands to determine its reported status.

## Fix Focus Areas
- py/docs/.readthedocs.yaml[15-53]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


REPO_DIR="$(pwd)"
PACKAGE="selenium"
VERSION="$(
Expand Down
Loading