Skip to content

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 123 commits into
base: b4b-dev
Choose a base branch
from
Draft

Update docs infrastructure #2809

wants to merge 123 commits into from

Conversation

samsrabin
Copy link
Collaborator

@samsrabin samsrabin commented Oct 3, 2024 •
edited
Loading

Description of changes

  • Removes dependence on outdated version of sphinx_rtd_theme
  • Enables embedding of Markdown docs in .rst files,
  • Adds Github workflow job to test documentation build whenever a PR is submitted with a branch from a fork that changes docs/
  • Adds Github workflow jobs to run for any PR with a branch from this repo that changes docs/:
  • Could rid us of the need for Docker and doc-builder (would require more testing; probably a different PR)

Blocked by ESMCI/doc-builder#5

Contributors other than yourself, if any: None

CTSM Issues Fixed (include github issue #):

Are answers expected to change (and if so in what way)? The way users switch between documentation versions will be different.

Any User Interface Changes (namelist or namelist defaults changes)? No

Testing performed, if any: Builds locally with no errors or warnings. Hopefully the version switching isn't broken—it looks broken locally, but I don't know if that's just an issue of it being local.

@samsrabin samsrabin added documentation additions or edits to user-facing documentation next this should get some attention in the next week or two. Normally each Thursday SE meeting. labels Oct 3, 2024
@samsrabin samsrabin added this to the ctsm6.0.0 (code freeze) milestone Oct 3, 2024
@samsrabin samsrabin mentioned this pull request Oct 3, 2024
Open
@wwieder wwieder removed the next this should get some attention in the next week or two. Normally each Thursday SE meeting. label Oct 3, 2024
@samsrabin samsrabin force-pushed the update-docs-builder-2 branch from f344a1e to ff003dd Compare October 3, 2024 19:42
@samsrabin samsrabin force-pushed the update-docs-builder-2 branch from ff003dd to c3788bb Compare October 3, 2024 19:48
@samsrabin samsrabin mentioned this pull request Oct 3, 2024
Closed
@samsrabin samsrabin moved this from Ready to start (or start again) to In progress - b4b-dev in CTSM: Upcoming tags Apr 17, 2025
@samsrabin
Copy link
Collaborator Author

samsrabin commented Apr 17, 2025 •
edited
Loading

  • Add -u/--update option to py_env_create.

@samsrabin samsrabin mentioned this pull request Apr 17, 2025
Open
@samsrabin
Copy link
Collaborator Author

Blocked by #2964.

samsrabin added 20 commits April 17, 2025 15:18
@samsrabin
Consolidate docs Workflows into docs.yml.
c9703ce
@samsrabin
Minor improvements to docs.yml.
4e6b62d
@samsrabin
Add -u/--update option to py_env_create.
28075a7
@samsrabin
Add GitHub Workflow to test building the ctsm-docs image.
f21708f
@samsrabin
Add test of docs build to docker-image-ctsm-docs-build.yml.
111c95c
@samsrabin
Fix (?) test build of docs using container.
0be19f4
@samsrabin
Test build of ctsm-docs container: Label :latest instead of pr-####.
0dff423
@samsrabin
Test build of ctsm-docs container: Remove continue-on-error.
2999b21 
Was marking as passed when it actually failed.
@samsrabin
Test build of ctsm-docs container: Try :latest again.
2e65820
@samsrabin
Update doc-builder to use correct image name.
b3b8811
@samsrabin
Test build of ctsm-docs container: Always name it escomp/ctsm/ctsm-docs
0a40ed6
@samsrabin
lint_and_format.yml: Fix handling of failed pylint check.
2c2c01d 
Now a failed pylint check should actually be marked as failing.
@samsrabin
Merge branch 'add-github-workflows-20250214' into update-docs-builder-2
e568c2a
@samsrabin
Workflows: Don't checkout all externals when we just need doc-builder.
148b16e
@samsrabin
Ensure _build directory exists and is writable.
9bf02f7
@samsrabin
Update doc-builder to run Docker command as current user.
4e0f54e
@samsrabin
Delete unneeded (?) "Ensure _build directory is writable" step.
e9304ba
@samsrabin
Add test-build-docs-container job to docs.yml.
0377fdb
@samsrabin
Remove continue-on-error from docs.yml.
e3b952a
@samsrabin
To save bandwidth, only test ctsm_pylib docs build if that env is upd…
ecbf6a3 
…ated.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@samsrabin samsrabin

Labels
bfb bit-for-bit blocked: dependency Wait to work on this until dependency is resolved code health improving internal code structure to make easier to maintain (sustainability) devops Development Operations to improve development throughput, E.g., adding GitHub Workflows documentation additions or edits to user-facing documentation enhancement new capability or improved behavior of existing capability test: none No tests required (e.g. tools/contrib) testing additions or changes to tests
Projects
CTSM6 documentation
Status: In Progress
CTSM: Upcoming tags
Status: In progress - b4b-dev
Milestone
ctsm6.0.0 (code freeze)
Development

Successfully merging this pull request may close these issues.

Update doc-builder
2 participants
@samsrabin @wwieder