Skip to content

Commit 29b5295

Browse files
committed
docs: Allow version_deprecated option
We also remove the unused 'version_changed' option. Signed-off-by: Stephen Finucane <[email protected]>
1 parent cb8e0fb commit 29b5295

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/tox_conf.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class ToxConfig(SphinxDirective):
2424
option_spec: Final[ClassVar[dict[str, Any]]] = {
2525
"keys": unchanged_required,
2626
"version_added": unchanged,
27-
"version_changed": unchanged,
27+
"version_deprecated": unchanged,
2828
"default": unchanged,
2929
"constant": flag,
3030
"ref_suffix": unchanged,
@@ -71,6 +71,10 @@ def run(self) -> list[Node]:
7171
line += Text(" 📢 added in ")
7272
ver = self.options["version_added"]
7373
line += literal(ver, ver)
74+
if "version_deprecated" in self.options:
75+
line += Text(" ⚠️ deprecated in ")
76+
ver = self.options["version_deprecated"]
77+
line += literal(ver, ver)
7478

7579
p = container("")
7680
self.state.nested_parse(StringList(string2lines("\n".join(f" {i}" for i in self.content))), 0, p)

0 commit comments

Comments
 (0)