-
Notifications
You must be signed in to change notification settings - Fork 341
Update docs infrastructure #2809
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
Conversation
ff003dd to
c3788bb
Compare
With minor changes to get it to work as Markdown embed. https://github.com/ESCOMP/CTSM/wiki/Directions-for-editing-CLM-documentation-on-github-and-sphinx
ekluzek
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome. Great work here. You already had us try the build workflow out and it worked for the group. So it obviously is working.
I have some suggestions, comments, and questions. I think the only important things I note is that ESMCI/doc-builder will need to be updated (but the new workflow is already telling you that). And I thought version_list should be different.
But, approving so you can do what you need to do and not need to get back to me.
doc/source/tech_note/Crop_Irrigation/CLM50_Tech_Note_Crop_Irrigation.rst
Show resolved
Hide resolved
|
@billsacks it seems like this would be good for you to review some of this. Just the doc building part of this that is. So ignore the .github workflow part and the python directory part, and just look at the changes under the doc directory that are outside of the users-guide and tech-note changes. Let us know if that's something you could do. Thanks for considering. |
|
File issue:
Added as #3121. |
billsacks
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I took a quick look at this. Thank you very much @samsrabin for all of your work to streamline the documentation build. This is very useful!!
|
Thanks, @billsacks! |
Environments resulting from -u vs. -o can differ in subtle ways. Deleting -u option to avoid this. Resolves samsrabin/docs-deploy-testing#8 This reverts commit acef2b1.
Raise minimum supported Python to 3.7.
Merge b4bdev 20250509 Updates to the b4b-dev branch since its last merge to master (PRs ESCOMP#3091 ESCOMP#3092), as shown by git log: - Merge pull request Update docs infrastructure ESCOMP#2809 from samsrabin/update-docs-builder-2 Update docs infrastructure - Merge pull request Update externals to cesm3_0_alpha06c ESCOMP#3106 from ekluzek/update_to_alpha06c Update externals to cesm3_0_alpha06c - Merge pull request User control over snow thermal conductivity scheme over glaciers ESCOMP#3072 from wwieder/JordanGlacier User control over snow thermal conductivity scheme over glaciers
Merge b4bdev 20250509 Updates to the b4b-dev branch since its last merge to master (PRs ESCOMP#3091 ESCOMP#3092), as shown by git log: - Merge pull request Update docs infrastructure ESCOMP#2809 from samsrabin/update-docs-builder-2 Update docs infrastructure - Merge pull request Update externals to cesm3_0_alpha06c ESCOMP#3106 from ekluzek/update_to_alpha06c Update externals to cesm3_0_alpha06c - Merge pull request User control over snow thermal conductivity scheme over glaciers ESCOMP#3072 from wwieder/JordanGlacier User control over snow thermal conductivity scheme over glaciers Conflicts: src/biogeochem/CNFireNoFireMod.F90
Merge b4bdev 20250509 Updates to the b4b-dev branch since its last merge to master (PRs ESCOMP#3091 ESCOMP#3092), as shown by git log: - Merge pull request Update docs infrastructure ESCOMP#2809 from samsrabin/update-docs-builder-2 Update docs infrastructure - Merge pull request Update externals to cesm3_0_alpha06c ESCOMP#3106 from ekluzek/update_to_alpha06c Update externals to cesm3_0_alpha06c - Merge pull request User control over snow thermal conductivity scheme over glaciers ESCOMP#3072 from wwieder/JordanGlacier User control over snow thermal conductivity scheme over glaciers
Merge b4bdev 20250509 Updates to the b4b-dev branch since its last merge to master (PRs ESCOMP#3091 ESCOMP#3092), as shown by git log: - Merge pull request Update docs infrastructure ESCOMP#2809 from samsrabin/update-docs-builder-2 Update docs infrastructure - Merge pull request Update externals to cesm3_0_alpha06c ESCOMP#3106 from ekluzek/update_to_alpha06c Update externals to cesm3_0_alpha06c - Merge pull request User control over snow thermal conductivity scheme over glaciers ESCOMP#3072 from wwieder/JordanGlacier User control over snow thermal conductivity scheme over glaciers
Merge b4bdev 20250509 Updates to the b4b-dev branch since its last merge to master (PRs ESCOMP#3091 ESCOMP#3092), as shown by git log: - Merge pull request Update docs infrastructure ESCOMP#2809 from samsrabin/update-docs-builder-2 Update docs infrastructure - Merge pull request Update externals to cesm3_0_alpha06c ESCOMP#3106 from ekluzek/update_to_alpha06c Update externals to cesm3_0_alpha06c - Merge pull request User control over snow thermal conductivity scheme over glaciers ESCOMP#3072 from wwieder/JordanGlacier User control over snow thermal conductivity scheme over glaciers
Merge b4bdev 20250509 Updates to the b4b-dev branch since its last merge to master (PRs ESCOMP#3091 ESCOMP#3092), as shown by git log: - Merge pull request Update docs infrastructure ESCOMP#2809 from samsrabin/update-docs-builder-2 Update docs infrastructure - Merge pull request Update externals to cesm3_0_alpha06c ESCOMP#3106 from ekluzek/update_to_alpha06c Update externals to cesm3_0_alpha06c - Merge pull request User control over snow thermal conductivity scheme over glaciers ESCOMP#3072 from wwieder/JordanGlacier User control over snow thermal conductivity scheme over glaciers
Merge b4bdev 20250509 Updates to the b4b-dev branch since its last merge to master (PRs ESCOMP#3091 ESCOMP#3092), as shown by git log: - Merge pull request Update docs infrastructure ESCOMP#2809 from samsrabin/update-docs-builder-2 Update docs infrastructure - Merge pull request Update externals to cesm3_0_alpha06c ESCOMP#3106 from ekluzek/update_to_alpha06c Update externals to cesm3_0_alpha06c - Merge pull request User control over snow thermal conductivity scheme over glaciers ESCOMP#3072 from wwieder/JordanGlacier User control over snow thermal conductivity scheme over glaciers
Description of changes
sphinx_rtd_themepush,pull_request,workflow_dispatch) to test doc build with bothmakeandbuild_docscalls:ghcr.io/escomp/ctsm/ctsm-docscontainer whenever anything changes indocs/ctsm_pylibwhenever anything changes inctsm_pylibenv file, and also at 8 am UTC Mondaysghcr.io/escomp/ctsm/ctsm-docscontainer whenever the setup of that container changesghcr.io/escomp/ctsm/ctsm-docscontainer whenever it's updatedsamr-test-20241003branchPublish docs update on mergeNo, do this separately. See Automatically publish updated docs #2839.Version before rebase is preserved here.
Contributors other than yourself, if any: None
CTSM Issues Fixed:
Are answers expected to change (and if so in what way)? Model code is unaffected. Various parts of the documentation will see minor changes.
Any User Interface Changes (namelist or namelist defaults changes)? No
Testing performed, if any: Local builds and new GitHub Workflows.