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.

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

Close #8619: html: kbd role generates customizable HTML tags for compound keys #8620

Merged
merged 1 commit into from Dec 31, 2020
Merged

Close #8619: html: kbd role generates customizable HTML tags for compound keys #8620

merged 1 commit into from Dec 31, 2020

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Dec 30, 2020

@tk0miya tk0miya added type:enhancement enhance or introduce a new feature markup builder:html labels Dec 30, 2020
@tk0miya tk0miya added this to the 3.5.0 milestone Dec 30, 2020
johnnovak
johnnovak approved these changes Dec 30, 2020
View reviewed changes
Copy link

@johnnovak johnnovak 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 @tk0miya for the quick turnaround on this! It's looking good, as far as I can tell.

@tk0miya tk0miya merged commit b31b8df into sphinx-doc:3.x Dec 31, 2020
@tk0miya tk0miya deleted the 8619_compound_kbd branch December 31, 2020 12:11
@mgeier
Copy link
Contributor

mgeier commented Dec 31, 2020

The CSS class compound is also used for "compound paragraphs" (see https://docutils.sourceforge.io/docs/ref/rst/directives.html#compound-paragraph). In this case it is used on a <div> element.

There might be themes that use compound as CSS query (without specifying div) and they might be surprised that also matches the :kbd: role.

I don't know whether this is a real problem, though.

@tk0miya
Copy link
Member Author

tk0miya commented Dec 31, 2020

@mgeier Thank you for comment. Good to hear. Okay, let's go as is. I think it's a bug if somebody's CSS hits the .compound element.

mgeier added a commit to mgeier-forks/insipid-sphinx-theme that referenced this pull request Feb 11, 2021
@mgeier
CSS: avoid multiple borders with compound "kbd" role
c765745 
This needs Sphinx >= 3.5.0, see
sphinx-doc/sphinx#8620.
This was referenced Feb 11, 2021
Merged
Merged
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@johnnovak johnnovak johnnovak approved these changes

Assignees
No one assigned
Labels
builder:html markup type:enhancement enhance or introduce a new feature
Projects
None yet
Milestone
3.5.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@tk0miya @mgeier @johnnovak