Skip to content

Fix dead documentation links - #3838

Open
farisbasha wants to merge 1 commit into
encode:masterfrom
farisbasha:docs/fix-dead-links
Open

farisbasha wants to merge 1 commit into
encode:masterfrom
farisbasha:docs/fix-dead-links

Conversation

@farisbasha

Copy link
Copy Markdown

Summary

Four documentation links return 404:

Where Old link New link
README.md ("Advanced Usage") https://www.python-httpx.org/advanced/ https://www.python-httpx.org/advanced/clients/ (first page of the Advanced section in mkdocs.yml)
.github/CONTRIBUTING.md advanced/#http-proxying, advanced/#ssl-certificates advanced/proxies/#http-proxies, advanced/ssl/ (the same targets docs/contributing.md already uses)
docs/third_party_packages.md (Authlib) https://docs.authlib.org/en/latest/client/httpx.html https://docs.authlib.org/en/latest/oauth2/client/http/httpx.html
docs/advanced/authentication.md (.netrc) https://everything.curl.dev/usingcurl/netrc https://everything.curl.dev/usingcurl/netrc.html

The README one also shows up on the PyPI project page.

Checked with curl -sL -o /dev/null -w '%{http_code}': every old URL returns 404, every new one returns 200, and the #http-proxies anchor exists on the proxies page.

Checklist

  • I understand that this PR may be closed in case there was no previous discussion. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change. (Docs links only; nothing to test.)
  • I've updated the documentation accordingly. (The change is the documentation.)

The README "Advanced Usage" link points at /advanced/, which is a 404
since the advanced docs were split into separate pages. Point it at the
first page of that section (advanced/clients/).

Also update three other links that now return 404:
- .github/CONTRIBUTING.md proxy and SSL anchors (same targets
  docs/contributing.md already uses)
- Authlib HTTPX client docs (moved under oauth2/client/http/)
- everything.curl.dev .netrc page (now needs the .html suffix)

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant