Skip to content
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.

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

GH-121970: Improve the glossary preview in HTML search #121991

Merged
merged 6 commits into from
Jul 19, 2024

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Jul 18, 2024

  • Pre-populate HTML via the template rather than creating it via JavaScript
  • Extract the JavaScript to its own file
  • Use async/await in JS
  • Fix a potential bug if there are multiple glossary terms for one entry

A


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

Example: https://cpython-previews--121991.org.readthedocs.build/en/121991/search.html?q=qualified+name

@AA-Turner AA-Turner added docs Documentation in the Doc dir skip news labels Jul 18, 2024
@AA-Turner AA-Turner requested a review from hugovk July 18, 2024 22:15
@AA-Turner AA-Turner added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Jul 19, 2024
@hugovk
Copy link
Member

hugovk commented Jul 19, 2024

Merging in main to unstick the CI.

@AA-Turner AA-Turner merged commit adf0b94 into python:main Jul 19, 2024
24 checks passed
@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 19, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 19, 2024
@bedevere-app
Copy link

bedevere-app bot commented Jul 19, 2024

GH-122015 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 Jul 19, 2024
@bedevere-app
Copy link

bedevere-app bot commented Jul 19, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Jul 19, 2024
AA-Turner added a commit that referenced this pull request Jul 19, 2024
) (#122016)

GH-121970: Improve the glossary preview in HTML search (GH-121991)
(cherry picked from commit adf0b94)

Co-authored-by: Adam Turner <[email protected]>
AA-Turner added a commit that referenced this pull request Jul 19, 2024
) (#122015)

GH-121970: Improve the glossary preview in HTML search (GH-121991)
(cherry picked from commit adf0b94)

Co-authored-by: Adam Turner <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants