From bc729e39da64a78a2202668253bf2736b4c451ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20=C5=A0pa=C4=8Dek?= Date: Fri, 24 Jun 2022 13:30:53 +0200 Subject: [PATCH] Add option to suppress grammar rendering A new flag .. namedconf:statement:: :suppress_grammar: suppresses pretty-printing grammar. It is useful mostly for zones because each zone has it's own grammar, so printing all of them at once usually does not make sense. (cherry picked from commit 1f5bc4fe3bc9c01bb38807604262c814fe9036a5) --- doc/arm/_ext/iscconf.py | 3 +++ doc/arm/reference.rst | 2 ++ 2 files changed, 5 insertions(+) diff --git a/doc/arm/_ext/iscconf.py b/doc/arm/_ext/iscconf.py index f4a74897e7..c4252c4202 100644 --- a/doc/arm/_ext/iscconf.py +++ b/doc/arm/_ext/iscconf.py @@ -96,6 +96,7 @@ def domain_factory(domainname, domainlabel, todolist, grammar): "tags": lambda arg: split_csv(arg, required=False), # one-sentece description for use in summary tables "short": directives.unchanged_required, + "suppress_grammar": directives.flag, } @property @@ -237,6 +238,8 @@ def domain_factory(domainname, domainlabel, todolist, grammar): union_flags = union_flags.union( set(one_grammar_dict.subgrammar.get("_flags", [])) ) + if "suppress_grammar" in self.options: + continue grammarnode = self.format_grammar(multi_grammar, grammar_grp) contentnode.insert(0, grammarnode) diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index b308f645b7..fff207374d 100644 --- a/doc/arm/reference.rst +++ b/doc/arm/reference.rst @@ -6178,6 +6178,7 @@ Here is an example of a typical split DNS setup implemented using ``zone`` Statement Grammar ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. namedconf:statement:: zone + :suppress_grammar: .. _zone_statement: @@ -6191,6 +6192,7 @@ Here is an example of a typical split DNS setup implemented using Zone Types ^^^^^^^^^^ .. namedconf:statement:: type + :suppress_grammar: The ``type`` keyword is required for the ``zone`` configuration unless it is an ``in-view`` configuration. Its acceptable values are: