Repository navigation
Enhance the documentation by correcting broken links and typos #584
Description
Describe the Task
METplus issue Documentation: Automate link checking with Sphinx #3247 revealed URLs in the documentation that need to be resolved in order for the newly added linkcheck workflow to pass.
Resolve the following:
Users_Guide/index.rst:32: [redirected permanently] http://www.apache.org/licenses/LICENSE-2.0 to https://www.apache.org/licenses/LICENSE-2.0
Users_Guide/overview.rst:22: [redirected permanently] http://www.dtcenter.org/ to https://dtcenter.org/
Users_Guide/index.rst:7: [redirected permanently] http://dtcenter.org/community-code/metplus to https://dtcenter.org/software-tools/metplus
Users_Guide/references.rst:36: [broken] https://doi.org/10.1017/S1350482701002092: 403 Client Error: Forbidden for url: https://rmets.onlinelibrary.wiley.com/doi/10.1017/S1350482701002092
Users_Guide/references.rst:29: [broken] https://doi.org/10.1029/2000JD900719: 403 Client Error: Forbidden for url: https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2000JD900719
Users_Guide/references.rst:16: [broken] https://doi.org/10.1002/qj.49712656313: 403 Client Error: Forbidden for url: https://rmets.onlinelibrary.wiley.com/doi/10.1002/qj.49712656313
Users_Guide/references.rst:23: [broken] https://doi.org/10.1175/2008WAF2222159.1: 405 Client Error: Not Allowed for url: https://journals.ametsoc.org/doi/10.1175/2008WAF2222159.1
Users_Guide/skew_t.rst:42: [broken] https://bmcnoldy.rsmas.miami.edu/papers/MMD_30HURR.pdf: HTTPSConnectionPool(host='bmcnoldy.rsmas.miami.edu', port=443): Max retries exceeded with url: /papers/MMD_30HURR.pdf (Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:1010)')))
Users_Guide/references.rst:9: [broken] https://doi.org/10.2307/2988240: 403 Client Error: Forbidden for url: https://www.jstor.org/stable/2988240?origin=crossref
Users_Guide/tcmpr_plots.rst:8: [broken] https://github.com/dtcenter/METplotpy/metplotpy/plots/tcmpr_plots: 404 Client Error: Not Found for url: https://github.com/dtcenter/METplotpy/metplotpy/plots/tcmpr_plots
Users_Guide/histogram_2d.rst:11: [redirected with Found] https://met.readthedocs.io/en/latest/Users_Guide/grid-diag.html to https://metplus.readthedocs.io/projects/met/en/latest/Users_Guide/grid-diag.html
Users_Guide/tcrmw_cross_section.rst:11: [redirected with Found] https://metcalcpy.readthedocs.io/en/develop/Users_Guide/vertical_interpolation.html to https://metplus.readthedocs.io/projects/metcalcpy/en/develop/Users_Guide/vertical_interpolation.html
Contributors_Guide/tests_github_actions.rst:9: [redirected with Found] https://metplotpy.readthedocs.io/en/develop/Contributors_Guide/new_plot.html#adding-a-new-plot to https://metplus.readthedocs.io/projects/metplotpy/en/develop/Contributors_Guide/new_plot.html#adding-a-new-plot
Users_Guide/taylor_diagram.rst:218: [redirected with Found] https://metplotpy.readthedocs.io/en/develop/Users_Guide/installation.html to https://metplus.readthedocs.io/projects/metplotpy/en/develop/Users_Guide/installation.html
Users_Guide/taylor_diagram.rst:8: [redirected with Found] https://metplotpy.readthedocs.io/en/develop/Users_Guide/references.html to https://metplus.readthedocs.io/projects/metplotpy/en/develop/Users_Guide/references.html
Contributors_Guide/conda_environment.rst:11: [redirected with Found] https://metplotpy.readthedocs.io/en/latest/Users_Guide/installation.html#python-requirements to https://metplus.readthedocs.io/projects/metplotpy/en/latest/Users_Guide/installation.html#python-requirements
Users_Guide/s2s_blocking.rst:12: [broken] https://metplus.readthedocs.io/en/develop/generated/model_applications/s2s/UserScript_fcstGFS_obsERA_Blocking.html#sphx-glr-generated-model-applications-s2s-userscript-fcstgfs-obsera-blocking-py: 404 Client Error: Not Found for url: https://metplus.readthedocs.io/en/develop/generated/model_applications/s2s/UserScript_fcstGFS_obsERA_Blocking.html
Users_Guide/mjo_rmm_omi.rst:24: [broken] https://metplus.readthedocs.io/en/develop/generated/model_applications/s2s/UserScript_obsERA_obsOnly_PhaseDiagram.html#sphx-glr-generated-model-applications-s2s-userscript-obsera-obsonly-phasediagram-py: 404 Client Error: Not Found for url: https://metplus.readthedocs.io/en/develop/generated/model_applications/s2s/UserScript_obsERA_obsOnly_PhaseDiagram.html
Users_Guide/stratosphere_diagnostics.rst:33: [broken] https://metplus.readthedocs.io/en/develop/generated/model_applications/s2s/UserScript_obsERA_obsOnly_Stratosphere.html#sphx-glr-generated-model-applications-s2s-userscript-obsera-obsonly-stratosphere-py: 404 Client Error: Not Found for url: https://metplus.readthedocs.io/en/develop/generated/model_applications/s2s/UserScript_obsERA_obsOnly_Stratosphere.html
Users_Guide/mjo_rmm_omi.rst:28: [broken] https://metplus.readthedocs.io/en/develop/generated/model_applications/s2s/UserScript_obsERA_obsOnly_OMI.html#sphx-glr-generated-model-applications-s2s-userscript-obsera-obsonly-omi-py: 404 Client Error: Not Found for url: https://metplus.readthedocs.io/en/develop/generated/model_applications/s2s/UserScript_obsERA_obsOnly_OMI.html
Users_Guide/contour.rst:172: [broken] https://metplotpy.readthedocs.io/en/latest/Users_Guide/installation-requirements.html: 404 Client Error: Not Found for url: https://metplus.readthedocs.io/projects/metplotpy/en/latest/Users_Guide/installation-requirements.html
Users_Guide/spacetime.rst:8: [broken] https://metplus.readthedocs.io/en/develop/generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html#sphx-glr-generated-model-applications-s2s-userscript-obsprecip-obsonly-crossspectraplot-py: 404 Client Error: Not Found for url: https://metplus.readthedocs.io/en/develop/generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html
Users_Guide/weather_regime.rst:8: [broken] https://metplus.readthedocs.io/en/develop/generated/model_applications/s2s/UserScript_obsERA_obsOnly_WeatherRegime.html#sphx-glr-generated-model-applications-s2s-userscript-obsera-obsonly-weatherregime-py: 404 Client Error: Not Found for url: https://metplus.readthedocs.io/en/develop/generated/model_applications/s2s/UserScript_obsERA_obsOnly_WeatherRegime.html
Users_Guide/release-notes.rst:25: [redirected with Found] https://github.com/dtcenter/METplotpy/issues/574 to https://github.com/dtcenter/METplotpy/pull/574
Contributors_Guide/pull_request.rst:5: [broken] https://metplus.readthedocs.io/en/latest/Contributors_Guide/github_workflow.html#open-a-pull-request-using-a-browse: Anchor 'open-a-pull-request-using-a-browse' not found
Users_Guide/roc_diagram.rst:24: [broken] https://metdataio.readthedocs.io/en/v3.0.0-beta3/Users_Guide/reformat_stat_data.html: 404 Client Error: Not Found for url: https://metplus.readthedocs.io/projects/metdataio/en/v3.0.0-beta3/Users_Guide/reformat_stat_data.html
Users_Guide/eclv.rst:13: [redirected with Found] https://metviewer.readthedocs.io/en/develop/Users_Guide/eclvplots.html to https://metplus.readthedocs.io/projects/metviewer/en/develop/Users_Guide/eclvplots.html
Users_Guide/taylor_diagram.rst:17: [redirected with Found] https://metviewer.readthedocs.io/en/develop/Users_Guide/taylordiag.html to https://metplus.readthedocs.io/projects/metviewer/en/develop/Users_Guide/taylordiag.html
Users_Guide/bar.rst:21: [redirected with Found] https://metviewer.readthedocs.io/en/latest/Users_Guide/barplots.html to https://metplus.readthedocs.io/projects/metviewer/en/latest/Users_Guide/barplots.html
Users_Guide/box.rst:8: [redirected with Found] https://metviewer.readthedocs.io/en/latest/Users_Guide/boxplot.html to https://metplus.readthedocs.io/projects/metviewer/en/latest/Users_Guide/boxplot.html
Users_Guide/performance_diagram.rst:8: [redirected with Found] https://metviewer.readthedocs.io/en/latest/Users_Guide/perfdiag.html to https://metplus.readthedocs.io/projects/metviewer/en/latest/Users_Guide/perfdiag.html
Users_Guide/contour.rst:8: [redirected with Found] https://metviewer.readthedocs.io/en/latest/Users_Guide/contourplot.html to https://metplus.readthedocs.io/projects/metviewer/en/latest/Users_Guide/contourplot.html
Users_Guide/reliability_diagram.rst:7: [redirected with Found] https://metviewer.readthedocs.io/en/latest/Users_Guide/reliabilityplots.html to https://metplus.readthedocs.io/projects/metviewer/en/latest/Users_Guide/reliabilityplots.html
Users_Guide/roc_diagram.rst:8: [redirected with Found] https://metviewer.readthedocs.io/en/latest/Users_Guide/rocplot.html to https://metplus.readthedocs.io/projects/metviewer/en/latest/Users_Guide/rocplot.html
Users_Guide/line.rst:7: [redirected with Found] https://metviewer.readthedocs.io/en/latest/Users_Guide/seriesplots.html to https://metplus.readthedocs.io/projects/metviewer/en/latest/Users_Guide/seriesplots.html
Users_Guide/fv3_physics.rst:52: [broken] https://ufs-srweather-app.readthedocs.io/en/latest/LAMGrids.html?highlight=grid#limited-area-model-lam-grids-predefined-and-user-generated-options: 404 Client Error: Not Found for url: https://ufs-srweather-app.readthedocs.io/en/latest/LAMGrids.html?highlight=grid
Users_Guide/skew_t.rst:13: [redirected permanently] https://www.e-education.psu.edu/meteo300/node/638 to https://courses.ems.psu.edu/meteo300/node/638
In addition, proofread the contents of the documentation. Correct typos, grammar, and punctuation, and fix content errors found along the way, such as option names, file names, and values that do not match the code or configuration files, and garbled or incomplete sentences.
Time Estimate
1-3 days
Sub-Issues
Consider breaking the task down into sub-issues.
- Add a checkbox for each sub-issue here.
Relevant Deadlines
As able
Funding Source
Split
Define the Metadata
Assignee
- Select engineer(s) or no engineer required
- Select scientist(s) or no scientist required
Labels
- Review default alert labels
- Select component(s)
- Select priority
- Select requestor(s)
Milestone and Projects
- Select Milestone as a METplotpy-X.Y.Z version, Consider for Next Release, or Backlog of Development Ideas
- For a METplotpy-X.Y.Z version, select the METplotpy-X.Y.Z Development project
Define Related Issue(s)
Consider the impact to the other METplus components.
Task 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 issue
Select: Milestone as the next official version
Select: METplotpy-X.Y.Z Development project for development toward the next official release - Iterate until the reviewer(s) accept and merge your changes.
- Delete your fork or branch.
- Close this issue.
Metadata
Metadata
Assignees
Type
Projects
- Status
Activity
Per #584, removing old files
13 remaining items
Per #584, add a Change Summary section to the top of the pull request…
Per #584, make the pull request template consistent across the METplu…
Per #584, update the pull request template to reference the coordinat…
Per #584, select the Support and/or Development project in the pull r…
Feature #584 linkcheck (#587)
JohnHalleyGotway commentedon Oct 14, 2026
Reopening this issue for one follow-up change. The linkcheck PR moved the link check into the Documentation workflow as a step at the end of the docs build job. In METplus (dtcenter/METplus#3359), the link check now runs as its own Check Links job instead, concurrently with the documentation build. That way the slower link check no longer delays the documentation result, and a broken link fails the Check Links job rather than Build Documentation, which makes it clear which one needs attention. I'll make the same change here in a new pull request (branch
feature_584_linkcheck_job).Per #584, run the link checker as a separate job that runs concurrent…