mir/bind
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-08-29 13:38:26 +00:00
Code Issues Releases Wiki Activity

Add tag filter to .. statementlist:: RST directive

Browse Source 
Introduce a new syntax:
.. namedconf:statementlist::
   :filter_tags: acl, resolver

The resulting table contains only items tagged as acl OR resolver.
This commit is contained in:
Petr Špaček 2022-05-13 16:36:28 +02:00
parent ff577462f9
commit 33931c97fa
1 changed files with 43 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
doc/arm/_ext/iscconf.py
View File

@ -65,8 +65,12 @@ def domain_factory(domainname, domainlabel, todolist):
process_statementlist_nodes() callback. process_statementlist_nodes() callback.
""" """
option_spec = {"filter_tags": lambda arg: split_csv(arg, required=True)}
def run(self): def run(self):
return [todolist("")] placeholder = todolist("")
placeholder["isc_filter_tags"] = set(self.options.get("filter_tags", []))
return [placeholder]
class ISCConfDomain(Domain): class ISCConfDomain(Domain):
""" """
@ -104,7 +108,7 @@ def domain_factory(domainname, domainlabel, todolist):
@property @property
def isc_tags(self): def isc_tags(self):
return self.options.get("tags", []) return set(self.options.get("tags", []))
@property @property
def isc_short(self): def isc_short(self):
@ -253,19 +257,47 @@ def domain_factory(domainname, domainlabel, todolist):
.. statementlist::) with automatically generated table .. statementlist::) with automatically generated table
of statements. of statements.
""" """
def gen_replacement_table(acceptable_tags):
table_header = [
TableColumn("ref", "Statement"),
TableColumn("short", "Description"),
]
table_b = DictToDocutilsTableBuilder(table_header)
table_b.append_iterable(
sorted(
iscconf.list_all(fromdocname),
key=lambda x: x["fullname"],
)
)
tag_header = []
if len(acceptable_tags) != 1:
# tags column only if tag filter is not applied
tag_header = [
TableColumn("tags_txt", "Tags"),
]
table_b = DictToDocutilsTableBuilder(table_header + tag_header)
table_b.append_iterable(
sorted(
filter(
lambda item: (
not acceptable_tags
or item["tags"].intersection(acceptable_tags)
),
iscconf.list_all(fromdocname),
),
key=lambda x: x["fullname"],
)
)
return table_b.get_docutils()
env = app.builder.env env = app.builder.env
iscconf = env.get_domain(cls.name) iscconf = env.get_domain(cls.name)
table_header = [
TableColumn("ref", "Statement name"),
TableColumn("short", "Short desc"),
TableColumn("tags_txt", "Tags"),
]
table_b = DictToDocutilsTableBuilder(table_header)
table_b.append_iterable(iscconf.list_all(fromdocname))
table = table_b.get_docutils()
for node in doctree.traverse(todolist): for node in doctree.traverse(todolist):
node.replace_self(table) acceptable_tags = node["isc_filter_tags"]
node.replace_self(gen_replacement_table(acceptable_tags))
def list_all(self, fromdocname): def list_all(self, fromdocname):
for statement in self.data["statements"].values(): for statement in self.data["statements"].values():