1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
import re
from docutils import nodes
from sphinx.transforms.post_transforms import SphinxPostTransform
from sphinx_design.dropdown import dropdown_main
class DropdownAnchorAdder(SphinxPostTransform):
"""Insert anchor links to the sphinx-design dropdowns.
Some of the dropdowns were originally headers that had automatic anchors, so we
need to make sure that the old anchors still work. See the original implementation
(in JS): https://github.com/scikit-learn/scikit-learn/pull/27409
The anchor links are inserted at the end of the node with class "sd-summary-text"
which includes only the title text part of the dropdown (no icon, markers, etc).
"""
default_priority = 9999 # Apply later than everything else
formats = ["html"]
def run(self):
"""Run the post transformation."""
# Counter to store the duplicated summary text to add it as a suffix in the
# anchor ID
anchor_id_counters = {}
for sd_dropdown in self.document.findall(dropdown_main):
# Grab the summary text node
sd_summary_text = sd_dropdown.next_node(
lambda node: "sd-summary-text" in node.get("classes", [])
)
# Concatenate the text of relevant nodes as the title text
title_text = "".join(node.astext() for node in sd_summary_text.children)
# The ID uses the first line, lowercased, with spaces replaced by dashes;
# suffix the anchor ID with a counter if it already exists
anchor_id = re.sub(r"\s+", "-", title_text.strip().split("\n")[0]).lower()
if anchor_id in anchor_id_counters:
anchor_id_counters[anchor_id] += 1
anchor_id = f"{anchor_id}-{anchor_id_counters[anchor_id]}"
else:
anchor_id_counters[anchor_id] = 1
sd_dropdown["ids"].append(anchor_id)
# Create the anchor element and insert after the title text; we do this
# directly with raw HTML
anchor_html = (
f'<a class="headerlink" href="#{anchor_id}" '
'title="Link to this dropdown">#</a>'
)
anchor_node = nodes.raw("", anchor_html, format="html")
sd_summary_text.append(anchor_node)
def setup(app):
app.add_post_transform(DropdownAnchorAdder)
|
