Updated rtd links (latest -> main)#416
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates hard-coded Read the Docs links from the “latest” version to the “main” branch across documentation.
- Switch compyle installation link in
installation.rstto point at themainversion. - Update badge image and target URLs in
README.rstto usemaininstead oflatest.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/source/installation.rst | Updated compyle config URL to reference en/main. |
| README.rst | Changed documentation badge and target to version=main. |
| `LLVM <https://formulae.brew.sh/formula/llvm>`_ can also be installed using | ||
| brew_, likewise. Once this is done, you can use the following | ||
| `compyle config <https://compyle.readthedocs.io/en/latest/installation.html#config>`_:: | ||
| `compyle config <https://compyle.readthedocs.io/en/main/installation.html#config>`_:: |
There was a problem hiding this comment.
[nitpick] Consider using a Sphinx variable or substitution for the RTD version in this URL to avoid having to update hard-coded links whenever the default branch changes.
Comment on lines
+24
to
+25
| .. |Documentation Status| image:: https://readthedocs.org/projects/pysph/badge/?version=main | ||
| :target: https://pysph.readthedocs.io/en/main/?badge=main |
There was a problem hiding this comment.
[nitpick] You could abstract the RTD version into a variable or use a Sphinx substitution to keep badge URLs in sync and minimize future version updates.
Suggested change
| .. |Documentation Status| image:: https://readthedocs.org/projects/pysph/badge/?version=main | |
| :target: https://pysph.readthedocs.io/en/main/?badge=main | |
| .. |Documentation Status| image:: https://readthedocs.org/projects/pysph/badge/?version=|rtd_version| | |
| :target: https://pysph.readthedocs.io/en/|rtd_version|/?badge=|rtd_version| |
This file contains hidden or 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
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.