python-guide icon indicating copy to clipboard operation
python-guide copied to clipboard

docs: update kennethreitz.org outdated links

Open brivadeneira opened this issue 4 months ago • 0 comments

docs: update kennethreitz.org outdated links

Verify external Kenneth Reitz URLs in documentation

Summary

This PR fixes outdated (404 not found) for all references to https://kennethreitz.org/ in the built Sphinx HTML documentation. The goal is to ensure that all external links are reachable and return a successful HTTP response.

File Original URL Fixed URL
CODE_OF_CONDUCT.md https://www.kennethreitz.org/essays/be-cordial-or-be-on-your-way https://kennethreitz.org/essays/2013/be_cordial_or_be_on_your_way
docs/conf.py https://www.kennethreitz.org/projects https://kennethreitz.org/software/
docs/dev/virtualenvs.rst https://pipenv.kennethreitz.org/ https://kennethreitz.org/software/pipenv
docs/writing/structure.rst https://kennethreitz.org/essays/2013/01/27/repository-structure-and-python https://kennethreitz.org/essays/2013/repository_structure_and_python
  • Issue
    • www.kennethreitz.org may redirect or 404 in some contexts.
    • Some paths changed on Kenneth Reitz’s site over the years (pipenv, repository structure essay).
    • Minor differences in URL encoding (- vs _) can break direct link checks.

Verification

  • Built the documentation in a clean Docker environment using Python 3.7:
docker run -it -p 8000:8000 -v $PWD:/app -w /app python:3.7 bash
pip install --upgrade pip
pip install sphinx
cd docs
make html
sphinx-build -b html -d _build/doctrees . _build/html
  • Grepped all Kenneth Reitz URLs from the built HTML:
grep -HoR "https://kennethreitz.org/[^\"'<> ]*" /app/docs/_build/html | cut -d':' -f2- | sort -u
  • Unique URLs found:

    • https://kennethreitz.org/essays/2013/repository_structure_and_python
    • https://kennethreitz.org/software/
    • https://kennethreitz.org/software/pipenv
  • Verified accessibility with HTTP HEAD requests using curl -I:

grep -HoR "https://kennethreitz.org/[^\"'<> ]*" /app/docs/_build/html \
  | cut -d':' -f2- \
  | sort -u \
  | xargs -n 1 curl -I

HTTP/2 200 
server: Fly/240521282 (2025-08-19)
date: Tue, 19 Aug 2025 20:49:15 GMT
content-type: text/html; charset=utf-8
content-length: 137640
via: 2 fly.io, 2 fly.io
fly-request-id: 01K321FQDBDM6CX295E6WEF305-cdg

HTTP/2 200 
server: Fly/240521282 (2025-08-19)
date: Tue, 19 Aug 2025 20:49:15 GMT
content-type: text/html; charset=utf-8
content-length: 134215
via: 2 fly.io, 2 fly.io
fly-request-id: 01K321FQQ2X3HH82S4GGWKTJ07-cdg

HTTP/2 200 
server: Fly/240521282 (2025-08-19)
date: Tue, 19 Aug 2025 20:49:15 GMT
content-type: text/html; charset=utf-8
content-length: 129003
via: 2 fly.io, 2 fly.io
fly-request-id: 01K321FR06WPX9X6XKQEKQTNT6-cdg
  • Results

✅ All referenced Kenneth Reitz URLs are reachable and return HTTP 200.

  • Documentation links referring to kennethreitz.org are safe to keep; no broken links detected.

brivadeneira avatar Aug 19 '25 20:08 brivadeneira