Skip to content

docs: update kennethreitz.org outdated links #1171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update kennethreitz.org outdated links #1171

wants to merge 1 commit into from

Conversation

brivadeneira
Copy link

@brivadeneira brivadeneira commented Aug 19, 2025 •
edited
Loading

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
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@brivadeneira