Repository navigation
docs(readme): serve the documentation badge through shields.io - #49
Merged
Merged
Conversation
The Read the Docs badge URL now redirects from readthedocs.org to app.readthedocs.org, and GitHub's image proxy shows it as a broken image. The shields.io Read the Docs badge reports the same build status and matches the style of the other badges. Signed-off-by: Jae Hoon Seo <jaehoon.seo@inha.ac.kr>
Owner
Author
|
@codex review |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
Codex Review: Didn't find any major issues. What shall we delve into next? Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
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.
Summary
The Documentation badge in the README shows as a broken image on GitHub. Its URL
(
readthedocs.org/projects/cabledyn/badge/) now answers with a redirect toapp.readthedocs.org, which GitHub's image proxy does not display. The badge now comes fromshields.io (
img.shields.io/readthedocs/cabledyn/latest), which reports the same buildstatus ("docs: passing") and matches the other badges. The link target is unchanged.
Checklist
pre-commit run --all-filespasses (README only)ctest --test-dir build --output-on-failurepasses (no code change)python -m pytest tests python/testspasses (README tests)doc/updated (not affected)feat:,fix:,docs:, ...)git commit -s) under theDeveloper Certificate of Origin