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.

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

Draft
wants to merge 59 commits into
base: b4b-dev
Choose a base branch
from

Conversation

samsrabin
Copy link
Collaborator

@samsrabin samsrabin commented Oct 3, 2024

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
@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
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

After merge of #2982:

  • Update python/conda_env_ctsm_py.txt to use doc/requirements.txt
  • Update GitHub workflows to use ctsm_pylib

@samsrabin samsrabin added bfb bit-for-bit and removed next this should get some attention in the next week or two. Normally each Thursday SE meeting. labels Mar 13, 2025
@samsrabin
Copy link
Collaborator Author

Blocked by ESMCI/doc-builder#5:

  • Update doc-builder in .gitmodules to point to the canonical version

@samsrabin samsrabin mentioned this pull request Mar 27, 2025
@samsrabin
Copy link
Collaborator Author

  • Add Github workflow testing build-docs with Docker container.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Status: In Progress
Development

Successfully merging this pull request may close these issues.

Update doc-builder
2 participants