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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
from collections.abc import Callable
from functools import partial
from typing import TYPE_CHECKING, Any, ClassVar, Literal, Optional, Union, cast
from docutils import nodes
from docutils.parsers.rst import directives
from sphinx.application import Sphinx
from sphinx.util.docutils import SphinxDirective
from sphinx.util.nodes import clean_astext
if TYPE_CHECKING:
from sphinx.domains.std import StandardDomain
_GH_BASE_URL = "https://github.com/litestar-org/advanced-alchemy"
def _parse_gh_reference(raw: str, type_: Literal["issues", "pull"]) -> list[str]:
return [f"{_GH_BASE_URL}/{type_}/{r.strip()}" for r in raw.split(" ") if r]
class Change(nodes.General, nodes.Element):
"""A change node for the changelog."""
class ChangeDirective(SphinxDirective):
"""A directive for the changelog."""
required_arguments = 1
has_content = True
final_argument_whitespace = True
option_spec: ClassVar[Optional[dict[str, Callable[[str], Any]]]] = {
"type": partial(directives.choice, values=("feature", "bugfix", "misc")),
"breaking": directives.flag,
"issue": directives.unchanged,
"pr": directives.unchanged,
}
def run(self) -> list[nodes.Node]:
"""Run the directive.
Returns:
A list of nodes.
"""
self.assert_has_content()
change_type = self.options.get("type", "misc").lower()
title = self.arguments[0]
change_node = nodes.container("\n".join(self.content))
change_node.attributes["classes"].append("changelog-change")
self.state.nested_parse(self.content, self.content_offset, change_node) # pyright: ignore[reportUnknownMemberType]
reference_links = [
*_parse_gh_reference(self.options.get("issue", ""), "issues"),
*_parse_gh_reference(self.options.get("pr", ""), "pull"),
]
references_paragraph = nodes.paragraph()
references_paragraph.append(nodes.Text("References: "))
for i, link in enumerate(reference_links, 1):
link_node = nodes.inline()
link_node += nodes.reference("", link, refuri=link, external=True)
references_paragraph.append(link_node)
if i != len(reference_links):
references_paragraph.append(nodes.Text(", "))
change_node.append(references_paragraph)
return [
Change(
"",
change_node,
title=self.state.inliner.parse(title, 0, self.state.memo, change_node)[0],
change_type=change_type,
breaking="breaking" in self.options,
),
]
class ChangelogDirective(SphinxDirective):
required_arguments = 1
has_content = True
option_spec = {"date": directives.unchanged}
def run(self) -> list[nodes.Node]:
self.assert_has_content()
version = self.arguments[0]
release_date = self.options.get("date")
changelog_node = nodes.section()
changelog_node += nodes.title(version, version)
section_target = nodes.target("", "", ids=[version])
if release_date:
changelog_node += nodes.strong("", "Released: ")
changelog_node += nodes.Text(release_date)
self.state.nested_parse(self.content, self.content_offset, changelog_node) # pyright: ignore[reportUnknownMemberType]
domain = cast("StandardDomain", self.env.get_domain("std"))
change_group_lists = {
"feature": nodes.definition_list(),
"bugfix": nodes.definition_list(),
"misc": nodes.definition_list(),
}
change_group_titles = {"bugfix": "Bugfixes", "feature": "Features", "misc": "Other changes"}
nodes_to_remove = []
for _i, change_node in enumerate(changelog_node.findall(Change)):
change_type = change_node.attributes["change_type"]
title = change_node.attributes["title"]
list_item = nodes.definition_list_item("")
term = nodes.term()
term += title
target_id = f"{version}-{nodes.fully_normalize_name(title[0].astext())}"
term += nodes.reference(
"#",
"#",
refuri=f"#{target_id}",
internal=True,
classes=["headerlink"],
ids=[target_id],
)
reference_id = f"change:{target_id}"
domain.anonlabels[reference_id] = self.env.docname, target_id
domain.labels[reference_id] = (
self.env.docname,
target_id,
f"Change: {clean_astext(title[0])}",
)
if change_node.attributes["breaking"]:
breaking_notice = nodes.inline("breaking", "breaking")
breaking_notice.attributes["classes"].append("breaking-change")
term += breaking_notice
list_item += [term]
list_item += nodes.definition("", change_node.children[0])
nodes_to_remove.append(change_node) # pyright: ignore[reportUnknownMemberType]
change_group_lists[change_type] += list_item
for node in nodes_to_remove: # pyright: ignore[reportUnknownVariableType]
changelog_node.remove(node) # pyright: ignore[reportUnknownArgumentType]
for change_group_type, change_group_list in change_group_lists.items():
if not change_group_list.children:
continue
section = nodes.section()
target_id = f"{version}-{change_group_type}"
target_node = nodes.target("", "", ids=[target_id])
title = change_group_titles[change_group_type]
section += nodes.title(title, title)
section += change_group_list
changelog_node += [target_node, section]
return [section_target, changelog_node]
def setup(app: Sphinx) -> dict[str, Union[str, bool]]:
app.add_directive("changelog", ChangelogDirective)
app.add_directive("change", ChangeDirective)
return {"parallel_read_safe": True, "parallel_write_safe": True}
|
