Skip to content
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

Update docs related to NOAA CSPs #3043

Open
wants to merge 49 commits into
base: develop
Choose a base branch
from

Conversation

weihuang-jedi
Copy link
Contributor

Description

With CSPs now capable or compile and run global-workflow for ATM forecast only, coupled, and gefs, and many changes at ParallelWorks, Docs should be updated to reflect all these changes.

Resolves #3042

Type of change

  • Bug fix (fixes something broken)
  • New feature (adds functionality)
  • Maintenance (code refactor, clean-up, new CI test, etc.)
  • [x ] Docs updating

Change characteristics

  • Is this a breaking change (a change in existing functionality)? NO
  • Does this change require a documentation update? YES
  • Does this change require an update to any of the following submodules? NO (If YES, please add a link to any PRs that are pending.)
    • EMC verif-global
    • GDAS
    • GFS-utils
    • GSI
    • GSI-monitor
    • GSI-utils
    • UFS-utils
    • UFS-weather-model
    • wxflow

How has this been tested?

  • checked the appearance on web site.

Checklist

  • Any dependent changes have been merged and published
  • [x ] My code follows the style guidelines of this project
  • [x ] I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have documented my code, including function, input, and output descriptions
  • [x ] My changes generate no new warnings
  • New and existing tests pass with my changes
  • This change is covered by an existing CI test or a new one has been added
  • Any new scripts have been added to the .github/CODEOWNERS file with owners
  • [x ] I have made corresponding changes to the system documentation if necessary

docs/source/conf.py Outdated Show resolved Hide resolved
@weihuang-jedi weihuang-jedi marked this pull request as ready for review November 13, 2024 04:59
Copy link
Member

@KateFriedman-NOAA KateFriedman-NOAA left a comment

Choose a reason for hiding this comment

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

Don't forget to delete the other pngs that are showing as being added or modified in this PR. Thanks!

@@ -25,6 +25,7 @@
# The full version, including alpha/beta/rc tags
release = '0.1'

numfig = True
Copy link
Member

Choose a reason for hiding this comment

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

Curious, what is this being added for?

Choose a reason for hiding this comment

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

This enables the use of :numref:%s <target> syntax to refer to numbered items like tables, figures, and sections of the documentation. For some reason, we are still having trouble getting crosslinks to render using both :numref: and :ref:, and I have not had a chance to explore other reasons why that might be, but this line is definitely required for :numref: to work, in addition to whatever other changes may be required.

Copy link
Member

Choose a reason for hiding this comment

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

Gotcha, thanks for explaining that @gspetro-NOAA !

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.

Update global-workflow CSPs docs
4 participants