Skip to content

Conversation

@JohnStrunk
Copy link
Member

Description

  • This PR cleans up the documentation build, fixing all warnings and errors.
  • It also adds a new check to PRs that builds the docs (unassociated w/ RTD's build process), stopping if any warnings are added to the documentation.

This PR fixes #3155

Notes for Reviewers

Signed commits

  • Yes, I signed my commits.

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 requested a review from sgoggins as a code owner June 11, 2025 20:01
@JohnStrunk
Copy link
Member Author

The RTD build is currently broken for dev due to the switch to uv. RTD is using the .readthedocs.yml from main which still has the old setup.py-based build.

https://app.readthedocs.org/api/v2/build/28480746.txt shows the config file that's being used, which is from main, not dev.

@sgoggins sgoggins self-assigned this Jun 13, 2025
sgoggins
sgoggins previously approved these changes Jun 13, 2025
Copy link
Member

@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.

Excellent!



**Python 3.9 is not yet supported because TensorFlow, which we use in our machine learning workers, does not yet support Python 3.9.**
Copy link
Member

Choose a reason for hiding this comment

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

OK ... wow. This is out of date.. Noting the need to fix it later.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is this fixed sir??

@sgoggins sgoggins changed the base branch from dev to main June 13, 2025 16:17
@sgoggins sgoggins dismissed their stale review June 13, 2025 16:17

The base branch was changed.

sgoggins
sgoggins previously approved these changes Jun 13, 2025
@sgoggins sgoggins added the documentation Updates documentation label Jun 13, 2025
@sgoggins sgoggins changed the base branch from main to dev June 13, 2025 20:25
@sgoggins sgoggins dismissed their stale review June 13, 2025 20:25

The base branch was changed.

@sgoggins sgoggins self-requested a review June 13, 2025 20:49
Copy link
Member

@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.

I think there's a jinja version issue based on the detailed debug log out put on readthedocs.io ... going to merge, because I think I fixed it in dev, and this is how we test that ..

@sgoggins sgoggins merged commit 8b68bf2 into chaoss:dev_old Jun 13, 2025
7 of 8 checks passed
@PredictiveManish
Copy link
Contributor

PredictiveManish commented Oct 22, 2025

There are some warnings inside the updated code by you sir @JohnStrunk it requires simple changes if you're doing this let me know otherwise I will do that as I'm new to this org these small changes will help me to understand better.

PredictiveManish added a commit to PredictiveManish/augur that referenced this pull request Oct 22, 2025
Signed-off-by: PredictiveManish <manisht0914@gmail.com>
PredictiveManish added a commit to PredictiveManish/augur that referenced this pull request Oct 22, 2025
Signed-off-by: PredictiveManish <manisht0914@gmail.com>
PredictiveManish added a commit to PredictiveManish/augur that referenced this pull request Oct 22, 2025
Signed-off-by: PredictiveManish <manisht0914@gmail.com>
PredictiveManish added a commit to PredictiveManish/augur that referenced this pull request Oct 23, 2025
Signed-off-by: PredictiveManish <manisht0914@gmail.com>
PredictiveManish added a commit to PredictiveManish/augur that referenced this pull request Oct 23, 2025
Signed-off-by: PredictiveManish <manisht0914@gmail.com>
sgoggins added a commit that referenced this pull request Oct 30, 2025
AumOzaa pushed a commit to AumOzaa/augur that referenced this pull request Nov 3, 2025
Signed-off-by: PredictiveManish <manisht0914@gmail.com>
AumOzaa pushed a commit to AumOzaa/augur that referenced this pull request Nov 3, 2025
Signed-off-by: PredictiveManish <manisht0914@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Updates documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix the documentation build

3 participants