Skip to content

Better handle RTD build status checking #409

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
FoamyGuy merged 1 commit into from
Mar 20, 2026
Merged

Better handle RTD build status checking #409

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
13 changes: 11 additions & 2 deletions tools/docs_status.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,12 @@ def check_docs_status(
search_results: parse.Result = parse.search(
"https://readthedocs.org/projects/{slug:S}/badge", readme_text
)
rtd_slug: str = search_results.named["slug"]
try:
rtd_slug: str = search_results.named["slug"]
except KeyError:
print("Possibly missing documentation badge")
return None

rtd_slug = rtd_slug.replace("_", "-", -1)

# GET the latest documentation build runs
Expand All @@ -75,7 +80,11 @@ def check_docs_status(
)
if doc_build_results is None:
return None
result = doc_build_results[0].get("success")
try:
result = doc_build_results[0].get("success")
except (IndexError, AttributeError):
print("Could not get success status")
return None
if debug and not result:
print(f"RTD build failed or unavailable for {lib_repo.name}")
time.sleep(3)
Expand Down
Loading