Skip to content

Conversation

@xylar
Copy link
Contributor

@xylar xylar commented Oct 3, 2025

Summary

Objectives:

  • Get the docs to build with python 3.13
  • Get docs building in CI in PRs, not just after merge

Select one: This pull request is...

  • a bug fix: increment the patch version
  • a small improvement: increment the minor version
  • a new feature: increment the minor version
  • an incompatible (non-backwards compatible) API change: increment the major version

Please fill out either the "Small Change" or "Big Change" section (the latter includes the numbered subsections), and delete the other.

Small Change

  • To merge, I will use "Squash and merge". That is, this change should be a single commit.
  • Logic: I have visually inspected the entire pull request myself.
  • Pre-commit checks: All the pre-commits checks have passed.

fixes #387

@xylar
Copy link
Contributor Author

xylar commented Oct 3, 2025

I'm going to push a fix to #387 to this branch soon.

@xylar xylar marked this pull request as draft October 3, 2025 21:35
@xylar xylar marked this pull request as ready for review October 3, 2025 21:37
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unfortunately, these changes won't take effect until after we merge the PR, it looks like. That's because I renamed the job, I presume.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, I take that back! It's running! Just took a sec.

@xylar
Copy link
Contributor Author

xylar commented Oct 3, 2025

This is working. Now getting sphinx 7.3.7 in build-docs instead of 5.3.0 in the the last main run of publish-docs.

@forsyth2 forsyth2 mentioned this pull request Oct 3, 2025
7 tasks
@xylar
Copy link
Contributor Author

xylar commented Oct 3, 2025

@forsyth2, this fixes the issue as shown by passing build-docs test.

Copy link
Collaborator

@forsyth2 forsyth2 left a comment

Choose a reason for hiding this comment

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

This is great, thanks @xylar!

@forsyth2 forsyth2 merged commit 3b5b0fd into E3SM-Project:main Oct 3, 2025
5 checks passed
@xylar xylar deleted the fix-docutils branch October 3, 2025 21:50
@forsyth2
Copy link
Collaborator

forsyth2 commented Oct 3, 2025

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.

[Feature]: Test build of the docs in PRs

2 participants