Fix docs links #41
Merged
Fix docs links #41
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
AlexisRenchon
force-pushed
the
ar/fix_docs_links
branch
from
1006ff4 to
cb1fd79
Compare
|
@Sbozzolo you can preview the docs here https://clima.github.io/ClimaDiagnostics.jl/previews/PR41/ I am pretty sure all links work now, but you can double check... I tried to write a better commit message too, as you suggested =) |
|
Perfect! If you add "Closes #8" to your PR message on GitHub, merging this PR will automatically close the issue. |
Sbozzolo
reviewed
May 16, 2024
The internal links of ClimaDiagnostics documentation were broken. This PR fixes those broken links. It follows the documentation from documenter.juliadocs.org/1.4/man/synthax/#ref-link.
AlexisRenchon
force-pushed
the
ar/fix_docs_links
branch
from
da19fe5 to
b062a5d
Compare
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.
Purpose
Currently, the documentation of ClimaDiagnostics (in dev) has some broken links. This PR fixes those broken links.
Note: I followed documenters docs, specifically this section: https://documenter.juliadocs.org/stable/man/syntax/#@ref-link
Closes #8