Docs maintenance #106
Merged
Docs maintenance #106
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Upgraded the OS to Ubuntu 24.04 and updated the Python toolchain to mambaforge-23.11 in the .readthedocs.yaml file. This ensures compatibility with the latest environment settings available on readthedocs.
Updated Sphinx and optional dependencies packages pinned versions in `environment-rtd.yaml` and `SalishSeaTools/environment.yaml` in preparation for Python 3.13 environment.
The deprecated list of strings appears to have been removed in
Sphinx=8. The default `source_suffix = {'.rst': 'restructuredtext'}` is
appropriate for this project.
douglatornell
added
documentation
Changed the reference link from `PullChangesFromNEMOsvn` to `PullChangesFromNEMO-3.6svn` in the Marlin commands documentation. This directs users to the correct details for using the `marlin` command.
Simplified and standardized the format of the docstrings for `geo_tools.get_ij_coordinates` function to improve readability. Changed the type annotations to inline format for better consistency with other parts of the code and to resolve warnings from Sphinx autodoc extension.
We changed from `master` to `main` years ago, but the tools docs don't get much love :-(
It changed from `nbviewer.jupyter.org` to `nbviewer.org` years ago, but the tools docs don't get much love :-(
Updated many URLs to HTTPS for better security.
We migrated from Bitbucket to GitHub years ago, but the tools docs don't get much love :-(
Replaced outdated Ocean Networks Canada API documentation URLs with the latest URLs. This ensures users are directed to the correct and updated documentation pages when seeking information on web service endpoints and methods.
Correct the URL in the NOCSCOMBINE documentation to use the "http" protocol instead of "https." This change ensures users can access the referenced page without facing connection issues.
The legacy docs for running jobs on `jasper` have gone away and more modern Alliance docs for running jobs aren't applicable to the context. So, just made the old link a literal string to prevent linkcheck from reporting it as broken.
Changed PySVN link from tigris.org to sourceforge.io for accuracy. Ensures that users are directed to the correct location for PySVN resources.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.