Enhancement: Enhance GHA documentation workflow with a custom action

[jprestop]

Describe the Enhancement

Enhance the GitHub Actions documentation workflow with a single custom action to reduce duplication and ensure consistency.

Items to include:

• In .readthedocs.yaml under sphinx, add fail_on_warning: true
• python-version: '3.10' should be listed (documentation.yml) across all repos, but is currently 3.8 in METdataio and METviewer.
• Make the workflow_dispatch trigger available across all repos in the main and develop branches. This will allow manual runs of the documentation workflow for a desired branch or tag.
• Use one definition of requirements for documentation. For example, currently, documentation.yml specifies any additional packages needed to build the documentation in GitHub Actions, but the docs/requirements.txt file specifics any additional packages needed to build the documentation in Read The Docs. We could bring those two together with a script called in documentation.yml using what is specified in docs/requirements.txt.
• Accomplish the work listed in these issues for make clean html
  - [ ] METplus #2034
  - [ ] MET #2436
  - [ ] METcalcpy #273
  - [ ] METdataio #179
  - [ ] METplotpy #316
  - [ ] METviewer #454
  - [ ] METplus-Training #57

See the metplus-action-release-checksum and the call to it as an example.

It looks like a metplus-action-build-documentation already exists but we don’t believe any of the METplus repos are actually using it. Check in with @georgemccabe about it, however, it looks like only @JohnHalleyGotway has made any commits.

Time Estimate

1-3 days of work

Sub-Issues

Consider breaking the enhancement down into sub-issues.

• See description for related issues.

Relevant Deadlines

None

Funding Source

TBD

Define the Metadata

Assignee

• Select engineer(s) or no engineer required
• Select scientist(s) or no scientist required

Labels

• Select component(s)
• Select priority
• Select requestor(s)

Projects and Milestone

• Select Repository and/or Organization level Project(s) or add alert: NEED CYCLE ASSIGNMENT label
• Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

• METplus, MET, METdataio, METviewer, METexpress, METcalcpy, METplotpy

Enhancement Checklist

See the METplus Workflow for details.

• Complete the issue definition above, including the Time Estimate and Funding Source.
• Fork this repository or create a branch of develop.
  Branch name: feature_<Issue Number>_<Description>
• Complete the development and test your changes.
• Add/update log messages for easier debugging.
• Add/update unit tests.
• Add/update documentation.
• Add any new Python packages to the METplus Components Python Requirements table.
• Push local changes to GitHub.
• Submit a pull request to merge into develop.
  Pull request: feature <Issue Number> <Description>
• Define the pull request metadata, as permissions allow.
  Select: Reviewer(s) and Development issues
  Select: Repository level development cycle Project for the next official release
  Select: Milestone as the next official version
• Iterate until the reviewer(s) accept and merge your changes.
• Delete your fork or branch.
• Close this issue.