Skip to content

Fix broken/deprecated documentation links in MEPs and testing guides#30343

Merged
rcomer merged 4 commits into
matplotlib:mainfrom
nrnavaneet:fix-broken-links
Jul 23, 2025
Merged

Fix broken/deprecated documentation links in MEPs and testing guides#30343
rcomer merged 4 commits into
matplotlib:mainfrom
nrnavaneet:fix-broken-links

Conversation

@nrnavaneet

@nrnavaneet nrnavaneet commented Jul 22, 2025 •
edited by rcomer
Loading

Copy link
Copy Markdown
Contributor

Summary

This PR fixes outdated or broken external links in the developer documentation, specifically in MEP10.rst, MEP11.rst, and testing.rst. These updates ensure the documentation remains accurate and accessible by replacing dead or deprecated links with reliable alternatives.

Updates

  • In MEP10.rst:
    Replaced the outdated NumPy HOWTO link with a reference to the modern numpydoc format documentation.
  • In MEP11.rst:
    Replaced the dead Grokbase link with a corresponding message from the Python mailing list archive.
    Removed the deprecated easy_install reference and pointed to more relevant tooling.
  • In testing.rst:
    Removed the dead http://pypi.testrun.org index reference in the detox installation command.
    Updated the pip command to use the default PyPI index

Credits

Thanks to @dstansby and @story645 for guidance on which broken links should be fixed.
Assisted by @chatgpt (OpenAI)

Ref #30306

@github-actions github-actions Bot added the Documentation: devdocs files in doc/devel label Jul 22, 2025
@nrnavaneet

nrnavaneet commented Jul 22, 2025

Copy link
Copy Markdown
Contributor Author

Hi, ive tried to find the appropriate links but if u feel they r not or if any other links has to be fixed, kindly lmk :)
Would be happy to fix

@nrnavaneet

nrnavaneet commented Jul 22, 2025

Copy link
Copy Markdown
Contributor Author

BTW these are all the broken links i found
[doc/api/prev_api_changes/api_changes_0.71.rst]:
[404] http://sourceforge.net/mailarchive/forum.php?thread_id=6323208&forum_id=36187 | Rejected status code (this depends on your "accept" configuration): Not Found
[404] http://sourceforge.net/mailarchive/forum.php?thread_id=6398890&forum_id=36187 | Rejected status code (this depends on your "accept" configuration): Not Found

[doc/api/prev_api_changes/api_changes_0.72.rst]:
[404] http://matplotlib.sf.net/matplotlib.pylab.html#-contour | Rejected status code (this depends on your "accept" configuration): Not Found

[doc/api/prev_api_changes/api_changes_0.99.x.rst]:
[ERROR] http://www.voidspace.org.uk/python/configobj.html | Network error: error sending request for url (http://www.voidspace.org.uk/python/configobj.html) Maybe a certificate error?

[doc/devel/document.rst]:
[404] http://matplotlib.org/stable/old_topic/old_info2 | Rejected status code (this depends on your "accept" configuration): Not Found

[doc/devel/MEP/MEP10.rst]:
[404] https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt | Rejected status code (this depends on your "accept" configuration): Not Found

[doc/devel/MEP/MEP11.rst]:
[522] http://grokbase.com/t/python/distutils-sig/109bdnfhp4/distutils-ann-setuptools-post-install-script-for-bdist-wininst | Rejected status code (this depends on your "accept" configuration): Unknown status code
[404] https://setuptools.readthedocs.io/en/latest/easy_install.html | Rejected status code (this depends on your "accept" configuration): Not Found

[doc/devel/testing.rst]:
[ERROR] http://pypi.testrun.org/ | Network error: error sending request for url (http://pypi.testrun.org/) Maybe a certificate error?

[doc/users/prev_whats_new/changelog.rst]:
[404] http://sourceforge.net/tracker/index.php?func=detail&aid=1587359&group_id=80706&atid=560722 | Rejected status code (this depends on your "accept" configuration): Not Found
[404] http://sourceforge.net/tracker/index.php?func=detail&aid=1716732&group_id=80706&atid=560720 | Rejected status code (this depends on your "accept" configuration): Not Found
[404] http://sourceforge.net/tracker/index.php?func=detail&aid=1744154&group_id=80706&atid=560720 | Rejected status code (this depends on your "accept" configuration): Not Found
[404] http://sourceforge.net/tracker/index.php?func=detail&aid=1866207&group_id=80706&atid=560722 | Rejected status code (this depends on your "accept" configuration): Not Found
[404] http://sourceforge.net/tracker/index.php?func=detail&aid=1962574&group_id=80706&atid=560720 | Rejected status code (this depends on your "accept" configuration): Not Found
[ERROR] http://www.voidspace.org.uk/python/configobj.html | Network error: error sending request for url (http://www.voidspace.org.uk/python/configobj.html) Maybe a certificate error?
[404] https://sourceforge.net/tracker/index.php?func=detail&aid=1986597&group_id=80706&atid=560720 | Rejected status code (this depends on your "accept" configuration): Not Found
[404] https://sourceforge.net/tracker/index.php?func=detail&aid=2823304&group_id=80706&atid=560720 | Rejected status code (this depends on your "accept" configuration): Not Found

rcomer
rcomer reviewed Jul 23, 2025
View reviewed changes
Comment thread doc/devel/testing.rst Outdated
@nrnavaneet

nrnavaneet commented Jul 23, 2025

Copy link
Copy Markdown
Contributor Author

Also, I noticed that some of the other links (like the SourceForge ones) point to older URLs or potentially outdated docs.
Should I go ahead and update those as well, or do we want to keep them as-is for now?
I asked about this in the issue earlier but didn’t get a response, so just double-checking here.

@nrnavaneet nrnavaneet requested a review from rcomer July 23, 2025 10:27
rcomer
rcomer reviewed Jul 23, 2025
View reviewed changes
Comment thread doc/devel/MEP/MEP10.rst Outdated
Comment thread doc/devel/MEP/MEP11.rst Outdated
Comment thread doc/devel/testing.rst Outdated
Comment thread doc/devel/testing.rst
@nrnavaneet nrnavaneet requested a review from rcomer July 23, 2025 11:38
rcomer
rcomer reviewed Jul 23, 2025
View reviewed changes
Comment thread doc/devel/MEP/MEP10.rst Outdated
Comment thread doc/devel/testing.rst
@nrnavaneet @rcomer
Update doc/devel/MEP/MEP10.rst
05d6d0c 
Co-authored-by: Ruth Comer <10599679+rcomer@users.noreply.github.com>
rcomer
rcomer approved these changes Jul 23, 2025
View reviewed changes

@rcomer rcomer left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @nrnavaneet! I took the liberty of removing the closing keyword from your PR summary, as there are a bunch more links to fix before we close the issue. But it's good to get started!

@rcomer rcomer merged commit ea350fa into matplotlib:main Jul 23, 2025
22 checks passed
@rcomer rcomer added this to the v3.11.0 milestone Jul 23, 2025
@rcomer rcomer mentioned this pull request Jul 23, 2025
Open
@nrnavaneet nrnavaneet deleted the fix-broken-links branch July 23, 2025 19:50
@nrnavaneet

nrnavaneet commented Jul 23, 2025

Copy link
Copy Markdown
Contributor Author

Thats alright :)
Thanks again for suggestions @rcomer .
Kindly lmk if there are any other links I can change from the list or any others.

QuLogic pushed a commit to QuLogic/matplotlib that referenced this pull request Jul 23, 2025
@nrnavaneet @rcomer @QuLogic
Fix broken/deprecated documentation links in MEPs and testing guides (m…
e6fe357 
…atplotlib#30343)

* Fixed broken links

* Minor changes

* Made requested changes

* Update doc/devel/MEP/MEP10.rst

Co-authored-by: Ruth Comer <10599679+rcomer@users.noreply.github.com>

---------

Co-authored-by: Ruth Comer <10599679+rcomer@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rcomer rcomer rcomer approved these changes

Assignees

No one assigned

Labels

Documentation: devdocs files in doc/devel

Projects

None yet

Milestone

v3.11.0

Development

Successfully merging this pull request may close these issues.

2 participants

@nrnavaneet @rcomer