Skip to content

Fix dead readthedocs links in README and compatibility docs - #3200

Open
farisbasha wants to merge 1 commit into
dpkp:masterfrom
farisbasha:docs-readthedocs-links
Open

farisbasha wants to merge 1 commit into
dpkp:masterfrom
farisbasha:docs-readthedocs-links

Conversation

@farisbasha

Copy link
Copy Markdown

Two links to the readthedocs site return 404:

  • README.rst, "Module CLI Interface": https://kafka-python.readthedocs.io/en/master/usage.html. There is no docs/usage.rst any more; the CLI reference is docs/cli/index.rst, which docs/index.rst already links as cli/index.html. The README now points to https://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/). Now https://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.

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant