summaryrefslogtreecommitdiffstats
path: root/scripts
diff options
context:
space:
mode:
authorAntoine Eiche <lewo@abesis.fr>2021-10-14 09:06:14 +0200
committerAntoine Eiche <lewo@abesis.fr>2021-10-14 09:06:14 +0200
commit74bb22799017b22b64fa4aa1a0ea46b8377d48e6 (patch)
tree7068d880ce1e8c2284733fe94e6b0bebc5d9db7e /scripts
parentfb85a3fe9e4f673f9c017a23ada00b05d61cdc6a (diff)
docs: remove output paths from generated documentation
Otherwise, the `testRstOptions` test would fail too often!
Diffstat (limited to 'scripts')
-rw-r--r--scripts/generate-rst-options.py37
1 files changed, 22 insertions, 15 deletions
diff --git a/scripts/generate-rst-options.py b/scripts/generate-rst-options.py
index da4e3dd..3a13074 100644
--- a/scripts/generate-rst-options.py
+++ b/scripts/generate-rst-options.py
@@ -1,5 +1,6 @@
import json
import sys
+import re
header = """
Mailserver Options
@@ -23,32 +24,38 @@ template = """
f = open(sys.argv[1])
options = json.load(f)
-options = { k: v for k, v in options.items() if k.startswith("mailserver.") }
+options = {k: v for k, v in options.items()
+ if k.startswith("mailserver.")}
+
+groups = ["mailserver.loginAccount",
+ "mailserver.certificate",
+ "mailserver.dkim",
+ "mailserver.fullTextSearch",
+ "mailserver.redis",
+ "mailserver.monitoring",
+ "mailserver.backup",
+ "mailserver.borg"]
-groups = [ "mailserver.loginAccount",
- "mailserver.certificate",
- "mailserver.dkim",
- "mailserver.fullTextSearch",
- "mailserver.redis",
- "mailserver.monitoring",
- "mailserver.backup",
- "mailserver.borg" ]
def print_option(name, value):
- if 'default' in v:
- if v['default'] == "":
+ if 'default' in value:
+ if value['default'] == "":
default = '- Default: ``""``'
else:
default = '- Default: ``{}``'.format(v['default'])
+ # Some default values contains OUTPUTPATHS which make the
+ # output not stable across nixpkgs updates.
+ default = re.sub('/nix/store/[\w.-]*/', '<OUTPUT-PATH>/', default) # noqa
else:
default = ""
print(template.format(
- key=k,
- line="-"*len(k),
- description=v['description'],
- type="- Type: ``{}``".format(v['type']),
+ key=name,
+ line="-"*len(name),
+ description=value['description'],
+ type="- Type: ``{}``".format(value['type']),
default=default))
+
print(header)
for k, v in options.items():
if any([k.startswith(c) for c in groups]):