Skip to content

Style: Reduce space consumed by headers and improve alignment #2533

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
hugovk merged 2 commits into from
Apr 19, 2022
Merged

Style: Reduce space consumed by headers and improve alignment #2533

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9045b30
Infra: Elide redundant title and PEP fields in displayed header table
CAM-Gerlach Apr 16, 2022
a9388b3
Style: Reduce vertical space of headers & improve margins/alignment
CAM-Gerlach Apr 16, 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
Next Next commit
Infra: Elide redundant title and PEP fields in displayed header table
  • Loading branch information
@CAM-Gerlach
CAM-Gerlach committed Apr 16, 2022
commit 9045b30242de282d6380530f7242a5ff3c89099d
12 changes: 11 additions & 1 deletion pep_sphinx_extensions/pep_processor/transforms/pep_title.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,19 @@ def apply(self) -> None:
pep_header_details = {}

# Iterate through the header fields, which are the first section of the document
desired_fields = {"PEP", "Title"}
fields_to_remove = []
for field in self.document[0]:
# Hold details of the attribute's tag against its details
row_attributes = {sub.tagname: sub.rawsource for sub in field}
pep_header_details[row_attributes["field_name"]] = row_attributes["field_body"]

# Store the redundant fields in the table for removal
if row_attributes["field_name"] in desired_fields:
fields_to_remove.append(field)

# We only need the PEP number and title
if pep_header_details.keys() >= {"PEP", "Title"}:
if pep_header_details.keys() >= desired_fields:
break

# Create the title string for the PEP
Expand All @@ -46,6 +52,10 @@ def apply(self) -> None:
pep_title_node.extend(document_children)
self.document.note_implicit_target(pep_title_node, pep_title_node)

# Remove the now-redundant fields
for field in fields_to_remove:
field.parent.remove(field)


def _line_to_nodes(text: str) -> list[nodes.Node]:
"""Parse RST string to nodes."""
Expand Down