-
Notifications
You must be signed in to change notification settings - Fork 955
Try 2: Fix warnings/errors in docs & ensure clean builds #3203
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
Conversation
I guess this is off-topic, but is this something you think Mergeify can help enforce for us in the future? IMO it would be nice to be able to have a red failing CI job present on open PRs that are somehow marked as dependent on other yet-to-be-merged PRs |
|
Also, it looks like this PR still contains some UV related changes - should those be moved to #3202 ? |
|
Yes, mergify can handle dependencies: https://docs.mergify.com/merge-protections/#depends-on (If I would have used the right syntax 😢) The uv-related commits are because this branch is build on top of my uv branch from #3202. Those will either go away or I can rebase once that merges. I originally tried to base this one on main directly, and I got a bunch of conflicts wrt uv. |
Signed-off-by: John Strunk <jstrunk@redhat.com>
Added a new job to check if documentation builds cleanly, using sphinx- build with extra options to ensure all documentation is generated correctly. Signed-off-by: John Strunk <jstrunk@redhat.com>
Signed-off-by: John Strunk <jstrunk@redhat.com>
|
Docs build is failing due to a reference to |
#3210 is the fix for the doc build on RTD |
sgoggins
left a comment
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.
LGTM! Thank you!
Changed the example response format from text to json5 in the login documentation. Added a comment to clarify the `expires` field. This update improves the readability and understanding of the API response structure for users. Signed-off-by: John Strunk <jstrunk@redhat.com>
sgoggins
left a comment
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.
With all the recent changes I don't know if I should believe the build failure on READTHEDOCS.IO ... The regular docs are building, and nothing here changes anything so I think the failed docs build is likely a byproduct of something else that is out of synce.
Description