Docs maintenance #52
Merged
Docs maintenance #52
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
douglatornell
added
documentation
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-dev.yaml`, `environment-test.yaml`, and `environment-rtd.yaml` in preparation for Python 3.13 environment.
douglatornell
force-pushed
the
docs-maint
branch
from
b241363 to
60455f9
Compare
Updated the black formatter for blacken-docs from version 21.10b0 to 24.10.0. This change ensures compatibility with the latest version of black and avoids a version conflict problem during setup of the the pre-commit virtualenv.
Change the intersphinx mapping for OceanParcels to its new documentation URL. This ensures references to OceanParcels documentation are correctly resolved during the build process.
Changed the documentation reference link in the Stokes_drift kernel to point to the correct section in the example notebooks. This ensures users can find more detailed usage examples without any confusion.
Changed the documentation reference link in the Stokes_drift kernel to point to the correct section in the example notebooks. This ensures users can find more detailed usage examples without any confusion.
Changed outdated Conda links in `docs/pkg_development.rst` and `docs/installation.rst` to their current URLs. This ensures users are directed to the most accurate and up-to-date documentation.
Updated Sphinx build and linkcheck commands example outputs.
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.
This PR updates the pre-commit, readthedocs, and development environment configurations and updates documentation for the MoaceanParcels project.