Fix autogenerated links to OpenMPI/MPICH docs #859
Merged
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
OpenMPI docs are hosted on a new website, and the docs for all the `*_c` functions are not available for that this MPI library. Also, MPICH docstrings are available at the moment for most functions only in the v4.0 website, not v4.1+.
giordano
commented
Aug 6, 2024
Comment on lines
+22
to
+30
| # Ideally we'd like to use the "latest" version of the docs, but MPICH v4.0 | ||
| # at the moment seems to be the last version with all the docstrings. | ||
| mpich = "[MPICH](https://www.mpich.org/static/docs/v4.0/www3/$(fname).html)" | ||
| # All the *_c functions are undocumented in OpenMPI website | ||
| if !endswith(string(fname), "_c") | ||
| openmpi = "[OpenMPI](https://docs.open-mpi.org/en/main/man-openmpi/man3/$(fname).3.html)" | ||
| # Few docstrings aren't available for MPICH | ||
| if fname in (:MPI_Status_c2f, :MPI_Status_f2c) || startswith(string(fname), "MPI_Type_create_f90_") | ||
| return """ |
There was a problem hiding this comment.
I'm not a fan of all these super ad-hoc checks, but the alternative is to have broken links 🤷
|
I sampled the links for a few docstrings in the preview of this PR and they are all working as expected. I'm going to merge this so that at least we have no more broken links, but if someone knows better and more reliable links to use we can always fix them afterwards. |
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.
OpenMPI docs are hosted on a new website, and the docs for all the
*_cfunctions are not available for that this MPI library. Also, MPICH docstrings are available at the moment for most functions only in the v4.0 website, not v4.1+. Extracted out of #856.