Skip to content

GH-121970: Extract pydoc_topics into a new extension #131256

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
Merged
merged 3 commits into from
Mar 19, 2025
Merged

GH-121970: Extract pydoc_topics into a new extension #131256

merged 3 commits into from
Mar 19, 2025

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Mar 14, 2025 •
edited
Loading

It seems the error was in #130492, the attempted fix. That PR stripped all trailing whitespace, which inadvertantley also removed the final newline, leading to syntax errors, as there were four consecutive quotation marks.

This PR reapplies the reverted commit (#131245), adds a trailing newline, and finally regenerates pydoc_data/topics.py.

A

📚 Documentation preview 📚: https://cpython-previews--131256.org.readthedocs.build/

@AA-Turner
Reapply "pythonGH-121970: Extract pydoc_topics into a new extensi…
29fccb6 
…on (python#129116)"

This reverts commit ca1bedc.
@AA-Turner
Final newline

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode
c3677e0
@AA-Turner
Regenerate pydoc_data/topics.py
Loading
Loading status checks…
c6fb2e9
@AA-Turner AA-Turner requested a review from hugovk as a code owner March 14, 2025 18:20
@bedevere-app bedevere-app bot mentioned this pull request Mar 14, 2025
Open
@AA-Turner AA-Turner added the docs Documentation in the Doc dir label Mar 14, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Mar 14, 2025
@hugovk
Copy link
Member

hugovk commented Mar 14, 2025

Thanks! Do you have a good way to reproduce the original failure in a minimal way?

@AA-Turner
Copy link
Member Author

Thanks! Do you have a good way to reproduce the original failure in a minimal way?

$ git switch -C investigate db62557e3d1b0de4ca17786bd53f9c825ad88721
$ make -CDoc pydoc-topics
$ cp Doc/build/pydoc-topics/topics.py Lib/pydoc_data/topics.py
$ git commit -am "regenerate pydoc-topics"
$ make ci

@AA-Turner
Copy link
Member Author

Ok, let's try again...

A

@AA-Turner AA-Turner merged commit c1a02f9 into python:main Mar 19, 2025
50 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Mar 19, 2025
@hugovk
Copy link
Member

hugovk commented Mar 20, 2025

🤞

And backport?

@AA-Turner AA-Turner added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Mar 20, 2025
@miss-islington-app
Copy link

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@AA-Turner AA-Turner deleted the docs/reapply-pydoc-topics branch March 20, 2025 15:21
@miss-islington-app
Copy link

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Sorry, @AA-Turner, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker c1a02f9101f0b2d9dc7cfb4b8be5193e7459a906 3.12

@miss-islington-app
Copy link

Sorry, @AA-Turner, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker c1a02f9101f0b2d9dc7cfb4b8be5193e7459a906 3.13

AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Mar 20, 2025
@AA-Turner
[3.13] pythonGH-121970: Extract pydoc_topics into a new extension (p…
Loading
Loading status checks…
819dec9 
…ythonGH-131256)

(cherry picked from commit c1a02f9)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Mar 20, 2025

GH-131511 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Mar 20, 2025
AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Mar 20, 2025
@AA-Turner
[3.12] pythonGH-121970: Extract pydoc_topics into a new extension (p…
Loading
Loading status checks…
bc68614 
…ythonGH-131256)

(cherry picked from commit c1a02f9)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Mar 20, 2025

GH-131512 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Mar 20, 2025
AA-Turner added a commit that referenced this pull request Mar 20, 2025
@AA-Turner
[3.13] GH-121970: Extract pydoc_topics into a new extension (GH-131256

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode
Loading
Loading status checks…
26b04a1 
) (#131511)

(cherry picked from commit c1a02f9)
AA-Turner added a commit that referenced this pull request Mar 20, 2025
@AA-Turner
[3.12] GH-121970: Extract pydoc_topics into a new extension (GH-131256
Loading
Loading status checks…
e1626c3 
) (#131512)

(cherry picked from commit c1a02f9)
seehwan pushed a commit to seehwan/cpython that referenced this pull request Apr 16, 2025
@AA-Turner @seehwan80
pythonGH-121970: Extract pydoc_topics into a new extension (python#…
a5f1976 
…131256)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hugovk hugovk

Assignees

@AA-Turner AA-Turner

Labels
docs Documentation in the Doc dir skip news
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@AA-Turner @hugovk