Repository navigation
Fix dead readthedocs links in README and compatibility docs - #3200
Open
farisbasha wants to merge 1 commit into
Open
farisbasha wants to merge 1 commit into
farisbasha wants to merge 1 commit into
Conversation
The README points the CLI section at usage.html, which no longer exists; the CLI reference is cli/index.html (as in docs/index.rst). The compatibility badge in docs/compatibility.rst links to /compatibility.html without the /en/master/ version prefix, which is a 404.
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.
Two links to the readthedocs site return 404:
README.rst, "Module CLI Interface":https://kafka-python.readthedocs.io/en/master/usage.html. There is nodocs/usage.rstany more; the CLI reference isdocs/cli/index.rst, whichdocs/index.rstalready links ascli/index.html. The README now points tohttps://kafka-python.readthedocs.io/en/master/cli/index.html.docs/compatibility.rst, kafka badge target:https://kafka-python.readthedocs.io/compatibility.html(no/en/master/). Nowhttps://kafka-python.readthedocs.io/en/master/compatibility.html, the same target the README badge uses.Both new URLs return 200 with
curl -sI(no redirect). Docs only.This change was found and prepared with the help of an AI assistant.