Skip to content

Styling: Remove field block highlights and restore definition list indent #2425

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

Merged
merged 2 commits into from
Mar 14, 2022
Merged

Styling: Remove field block highlights and restore definition list indent #2425

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be6ecc2
Restore definition list item margin
AA-Turner Mar 13, 2022
d719787
Remove field block highlighting
AA-Turner Mar 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions pep_sphinx_extensions/pep_theme/static/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,6 @@ pre {
dl dt {
font-weight: bold;
}
dl dd {
margin: 0;
}

Copy link
Member

@CAM-Gerlach CAM-Gerlach Mar 13, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
dl dd {
margin-bottom: 0.5rem;
}

Unfortunately, this doesn't fix the problem reported in #2300 , where the vertical margin varies substantially between entries with multiple paragraphs (i.e, another <p> element) and those that only have one. Furthermore, the margins are still pretty tight as @pradyunsg reported, making them uncomfortable to read; they should be at least equivalent to the normal margin between paragraph-level elements.

See PEP 639 for an example:

image

This resolves both of those concerns by just ensuring that dl dd (except headers and footnotes, which are already overridden) have the same 0.5rem bottom vertical margin as paragraphs do:

image

Copy link
Member

@pradyunsg pradyunsg Mar 13, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Let's fix the line spacing in a follow up. It isn't limited to these dls. :)

Copy link
Member

Choose a reason for hiding this comment

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

There are definitely other issues with line spacing, but this was one of the most immediately noticeable, and this particular issue is not just that the line spacing is too narrow but that is visibly inconsistent between definitions with multiple paragraphs and those with only a single one, so I'm not sure we should let the fact that there are also other issues with line spacing block fixing this one.

However, if we do this, this PR should be unmarked as resolving #2300 , because this was the initial problem that prompted and was cited in said issue.

Copy link
Member

Choose a reason for hiding this comment

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

Opened as #2427

/* Horizontal rule rule */
hr {
Expand Down Expand Up @@ -247,21 +244,21 @@ dl.footnote {
grid-template-columns: fit-content(30%) auto;
line-height: 1.875;
width: 100%;
border-top: 1px solid var(--colour-background-accent);
border-bottom: 1px solid var(--colour-background-accent);
border-top: 1px solid var(--colour-rule-strong);
}
dl.rfc2822 > dt, dl.rfc2822 > dd,
dl.footnote > dt, dl.footnote > dd {
padding: .25rem .5rem .2rem;
}
dl.rfc2822 > dt:nth-of-type(even), dl.rfc2822 > dd:nth-of-type(even),
dl.footnote > dt:nth-of-type(even), dl.footnote > dd:nth-of-type(even) {
background-color: var(--colour-background-accent);
border-bottom: 1px solid var(--colour-rule-strong);
}
dl.footnote > dt {
font-weight: normal;
border-right: 1px solid var(--colour-background);
}
dl.rfc2822 dd,
dl.footnote dd {
margin: 0;
}

/* Sidebar formatting */
#pep-sidebar {
Expand Down