Skip to content

Try 2: Fix warnings/errors in docs & ensure clean builds#3203

Merged
sgoggins merged 4 commits intoaugurlabs:mainfrom
JohnStrunk:docs-try2
Jul 7, 2025
Merged

Try 2: Fix warnings/errors in docs & ensure clean builds#3203
sgoggins merged 4 commits intoaugurlabs:mainfrom
JohnStrunk:docs-try2

Conversation

@JohnStrunk
Copy link
Copy Markdown
Contributor

@MoralCode
Copy link
Copy Markdown
Collaborator

Depends on #3202 <== Merge that first!

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

@MoralCode
Copy link
Copy Markdown
Collaborator

Also, it looks like this PR still contains some UV related changes - should those be moved to #3202 ?

@JohnStrunk
Copy link
Copy Markdown
Contributor Author

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.

@MoralCode MoralCode mentioned this pull request Jul 2, 2025
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>
@JohnStrunk JohnStrunk marked this pull request as ready for review July 2, 2025 15:43
@JohnStrunk JohnStrunk requested a review from sgoggins as a code owner July 2, 2025 15:43
@MoralCode
Copy link
Copy Markdown
Collaborator

Docs build is failing due to a reference to setup.py

@JohnStrunk
Copy link
Copy Markdown
Contributor Author

Docs build is failing due to a reference to setup.py

#3210 is the fix for the doc build on RTD

Copy link
Copy Markdown
Collaborator

@sgoggins sgoggins left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

sgoggins
sgoggins previously approved these changes Jul 7, 2025
Comment thread docs/source/conf.py
Comment thread docs/source/index.rst
Comment thread docs/source/login.rst Outdated
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>
Copy link
Copy Markdown
Collaborator

@sgoggins sgoggins left a 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.

@sgoggins sgoggins merged commit 4e64a17 into augurlabs:main Jul 7, 2025
8 of 9 checks passed
@JohnStrunk JohnStrunk deleted the docs-try2 branch July 9, 2025 15:59
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.

4 participants