Skip to content
New issue

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

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

Already on GitHub? # to your account

GH-103484: Docs: add linkcheck allowed redirects entries for most cases #103569

Merged
merged 3 commits into from
Apr 18, 2023

Conversation

rffontenelle
Copy link
Contributor

@rffontenelle rffontenelle commented Apr 15, 2023

This is one of the patches required to fix the current state of make linkcheck in Python Docs, see #103484.

This pull request solves the cases that result in the most output (8000+ of 8327 output lines) when running make linkcheck. Find below examples of each case.

c-api/intro.rst:178: [redirected permanently] https://bugs.python.org/issue?@action=redirect&bpo=33720 to https://github.com/python/cpython/issues/77901

This redirect is caused by using the bpo-NNNNN custom role, which links https://bugs.python.org/issueNNNNN. Accessing that will redirect to CPython's GitHub issues. Instead of changing all occurrences to GH-NNNNN, this marks that redirect as allowed.

whatsnew/3.12.rst:185: [redirected with Found] https://github.com/python/cpython/issues/100581 to https://github.com/python/cpython/pull/100581

This is caused by using GH-NNNNN (which links to GitHub issues) to link pull requests. Instead of adding a new syntax for GitHub pull requests, this marks that redirect as allowed.

library/collections.abc.rst:13: [redirected permanently] https://github.com/python/cpython/tree/main/Lib/_collections_abc.py to https://github.com/python/cpython/blob/main/Lib/_collections_abc.py

This is caused by using :source:`something` to link a file. source results in 'https://github.com/python/cpython/tree/main/' + something, but the url for files in GitHub repos is /blob/ instead of /tree/. Changing :source:'s URL from /tree/ to /blob/ wouldn't solve it because if a directory was linked, it would pop-up a redirect from /blob/ to /tree/. Hence it is better to allow this redirect.

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thank you!

@Ismaelkadir

This comment was marked as spam.

Linkcheck reports no issue with URLs to BPO
@hugovk hugovk merged commit f39e00f into python:main Apr 18, 2023
@hugovk
Copy link
Member

hugovk commented Apr 18, 2023

Thank you!

@hugovk hugovk added the needs backport to 3.11 only security fixes label Apr 18, 2023
@miss-islington
Copy link
Contributor

Thanks @rffontenelle for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 18, 2023
…st cases (pythonGH-103569)

(cherry picked from commit f39e00f)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-bot
Copy link

GH-103602 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Apr 18, 2023
miss-islington added a commit that referenced this pull request Apr 18, 2023
…es (GH-103569)

(cherry picked from commit f39e00f)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
carljm added a commit to carljm/cpython that referenced this pull request Apr 20, 2023
* main: (24 commits)
  pythongh-98040: Move the Single-Phase Init Tests Out of test_imp (pythongh-102561)
  pythongh-83861: Fix datetime.astimezone() method (pythonGH-101545)
  pythongh-102856: Clean some of the PEP 701 tokenizer implementation (python#103634)
  pythongh-102856: Skip test_mismatched_parens in WASI builds (python#103633)
  pythongh-102856: Initial implementation of PEP 701 (python#102855)
  pythongh-103583: Add ref. dependency between multibytecodec modules (python#103589)
  pythongh-83004: Harden msvcrt further (python#103420)
  pythonGH-88342: clarify that `asyncio.as_completed` accepts generators yielding tasks (python#103626)
  pythongh-102778: IDLE - make sys.last_exc available in Shell after traceback (python#103314)
  pythongh-103582: Remove last references to `argparse.REMAINDER` from docs (python#103586)
  pythongh-103583: Always pass multibyte codec structs as const (python#103588)
  pythongh-103617: Fix compiler warning in _iomodule.c (python#103618)
  pythongh-103596: [Enum] do not shadow mixed-in methods/attributes (pythonGH-103600)
  pythonGH-100530: Change the error message for non-class class patterns (pythonGH-103576)
  pythongh-95299: Remove lingering setuptools reference in installer scripts (pythonGH-103613)
  [Doc] Fix a typo in optparse.rst (python#103504)
  pythongh-101100: Fix broken reference `__format__` in `string.rst` (python#103531)
  pythongh-95299: Stop installing setuptools as a part of ensurepip and venv (python#101039)
  pythonGH-103484: Docs: add linkcheck allowed redirects entries for most cases (python#103569)
  pythongh-67230: update whatsnew note for csv changes (python#103598)
  ...
@rffontenelle rffontenelle deleted the patch-1 branch April 22, 2023 15:38
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants