Skip to content
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

Bump sphinx to 6.2.1 on devel #320

Merged
merged 1 commit into from
Aug 24, 2023

Conversation

oraNod
Copy link
Contributor

@oraNod oraNod commented Aug 23, 2023

Resolves #267

@github-actions github-actions bot added the needs_triage Needs a first human triage before being processed. label Aug 23, 2023
tests/requirements.txt Outdated Show resolved Hide resolved
@oraNod oraNod force-pushed the issue-267/sphinx-version branch from 6edeb69 to a1af708 Compare August 23, 2023 14:31
@oraNod oraNod requested a review from gotmax23 August 23, 2023 14:37
Copy link
Collaborator

@gotmax23 gotmax23 left a comment

Choose a reason for hiding this comment

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

This looks good now, but let's wait to merge it until we can do a test Jenkins build. Also note that this may conflict with the sphinx-intl PR. You'll probably need to re-run pip-compile or manually resolve conflicts after merging the first one. It might be better to submit a single PR so everything can be tested and acked in one go.

@oraNod
Copy link
Contributor Author

oraNod commented Aug 23, 2023

Thanks @gotmax23 I'm going to build this on test today and would like to get it merged separately to the sphinx-intl PR. I think devel should be using 6.2.1 instead of the 5.3.0 version it is currently using. I'll rebase the sphinx-intel PR on top of this one.

@oraNod oraNod added doc builds Relates to building the documentation and removed needs_triage Needs a first human triage before being processed. labels Aug 23, 2023
@oraNod
Copy link
Contributor Author

oraNod commented Aug 23, 2023

I've tested this in a jenkins build and it is successful. Here are the full logs: https://gist.githubusercontent.com/oraNod/ca315a3e2f51e4fbcb3b4926264d8b49/raw/fd09859cca342af2ef9e5d39a71745b7f7378092/gistfile1.txt

Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

Just putting a hold on this until I can verify the output as it's a major version change to sphinx.

@samccann
Copy link
Contributor

Don's pr up on test if anyone else wants to get eyes on it - http://docs.testing.ansible.com/ansible/devel/index.html

@samccann
Copy link
Contributor

Also for those looking - changelog for sphinx 6.2.1 - https://www.sphinx-doc.org/en/master/changes.html#release-6-2-1-released-apr-25-2023

Read all the way back to 5.3.0 as that's what we currently use.

@samccann
Copy link
Contributor

@oraNod a comment in chat asked if we can jump straight to 7.1.2?

@samccann
Copy link
Contributor

Now looking similar to #329 so we should decide which PR moves forward and then stage to test and review.

@oraNod
Copy link
Contributor Author

oraNod commented Aug 24, 2023

Just putting a hold on this until I can verify the output as it's a major version change to sphinx.

FWIW we were already using 6.2.1 from the docs/docsite/requirements.txt file on the devel branch (latest package docs) before we started with all the requirements changes. In effect we actually went back a major version to 5.3 on the devel branch and this PR restores the version (see comment #267 (comment))

Also I think we've already agreed not to use the relaxed requirements for any of the automated builds, right? We should use relaxed for test builds and locals. So #329 is a separate thing.

@oraNod oraNod requested a review from samccann August 24, 2023 08:38
@samccann
Copy link
Contributor

So we do want less-pinned builds for devel, and the stable (what we used to call known-good because.. we knew it would work) for stable branch builds.

that is - we still want the canary in the coal mine build on devel. Like we discovered sphinx 7.2.2 doesn't work, and adapted around it.

@samccann
Copy link
Contributor

Approved if you want to merge, but I do think we should jump to 7.1.2 on devel soonish as well (on devel).

@samccann samccann merged commit a4ef915 into ansible:devel Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc builds Relates to building the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

sphinx version on devel
3 participants