Skip to content

Update doc-builder to v3.5.10 - #4246

Draft
samsrabin wants to merge 3 commits into
ESCOMP:b4b-devfrom
samsrabin:update-doc-builder-v3.5.10
Draft

samsrabin wants to merge 3 commits into
ESCOMP:b4b-devfrom
samsrabin:update-doc-builder-v3.5.10

Conversation

@samsrabin

@samsrabin samsrabin commented Oct 6, 2026 •

Copy link
Copy Markdown
Member

Description of changes

Updates doc-builder from v3.2.1 to v3.5.10. Main improvements:

  • Substitutions are now available in Markdown
  • Container now lives in ESMCI/doc-builder, not ESCOMP/CTSM.
  • preview_docs_pr now lives in ESMCI/doc-builder, not ESCOMP/CTSM.

Specific notes

Contributors other than yourself, if any:

  • (Replace this text and add more list items as needed)

CTSM issues resolved or otherwise addressed, if any:

  • (Replace this text, including GitHub issue #, and add more list items as needed)

If answers are expected to change, describe (delete this line otherwise):

Any user interface changes (namelist or namelist defaults changes)?

Testing planned or performed, if any:

  • Automated testing on this PR

Remaining work

  • CI will likely be broken until this is done Copy/update CTSM-side infrastructure files as needed
  • Update docs docs with instructions for using substitutions in Markdown
  • If necessary: Update docs docs to point to ESMCI/doc-builder for the container, not ESCOMP/CTSM.
  • Tear out everything about our doc-building container.
  • preview_docs_pr should now point at the doc-builder version

Requirements before merge:

  • The code in this PR branch builds with no errors.
  • The code in this PR branch runs with no errors. Briefly describe tested configuration(s):
  • This either (a) does not change answers, (b) it only changes answers at roundoff level, or (c) I have performed a scientific evaluation of the answer changes. a*
  • I have reviewed relevant parts of the CLM documentation Tech Note or User's Guide to determine if anything needs to be changed or added. If it does, describe:
  • This PR either (a) does not create a need to update the documentation or (b) includes required documentation updates (see guidelines for contributing documentation). Which?:

@samsrabin
samsrabin marked this pull request as draft October 6, 2026 19:29
@samsrabin samsrabin self-assigned this Oct 6, 2026
@samsrabin samsrabin added b4b bit-for-bit docs:infrastructure New features or bug fixes in the documentation infrastructure docs-loc:infrastructure Relates to documentation infrastructure labels Oct 6, 2026
@samsrabin samsrabin added this to the ctsm6.0.0 (code freeze) milestone Oct 6, 2026
@samsrabin
samsrabin force-pushed the update-doc-builder-v3.5.10 branch from 949490a to d0a14ae Compare October 6, 2026 19:42
@samsrabin
samsrabin changed the base branch from master to b4b-dev October 6, 2026 19:52
@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown

❌ Docs build failed

Build logs

@samsrabin samsrabin added the devops Development Operations to improve development throughput, E.g., adding GitHub Workflows label Oct 19, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

b4b bit-for-bit devops Development Operations to improve development throughput, E.g., adding GitHub Workflows docs:infrastructure New features or bug fixes in the documentation infrastructure docs-loc:infrastructure Relates to documentation infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant