diff options
author | Robert Hensing <robert@roberthensing.nl> | 2022-11-11 06:15:46 +0100 |
---|---|---|
committer | Robert Hensing <robert@roberthensing.nl> | 2022-11-11 06:29:44 +0100 |
commit | 429ba6c71426418562b2047cf1433d3ed6f45533 (patch) | |
tree | 7e682fe4d31396af4863e1913d039e67194b23f0 /nixos/lib | |
parent | d1fc8fa8b4dd3ae7c48c5f783a5e5bf6d44d88ca (diff) |
nixosOptionsDoc: Add markdownByDefault parameter
Diffstat (limited to 'nixos/lib')
-rw-r--r-- | nixos/lib/make-options-doc/default.nix | 3 | ||||
-rw-r--r-- | nixos/lib/make-options-doc/mergeJSON.py | 7 |
2 files changed, 10 insertions, 0 deletions
diff --git a/nixos/lib/make-options-doc/default.nix b/nixos/lib/make-options-doc/default.nix index dde3cac1c1bab..e097aa5eebd8e 100644 --- a/nixos/lib/make-options-doc/default.nix +++ b/nixos/lib/make-options-doc/default.nix @@ -40,6 +40,8 @@ # `false`, and a different renderer may be used with different bugs and performance # characteristics but (hopefully) indistinguishable output. , allowDocBook ? true +# whether lib.mdDoc is required for descriptions to be read as markdown. +, markdownByDefault ? false }: let @@ -152,6 +154,7 @@ in rec { python ${./mergeJSON.py} \ ${lib.optionalString warningsAreErrors "--warnings-are-errors"} \ ${lib.optionalString (! allowDocBook) "--error-on-docbook"} \ + ${lib.optionalString markdownByDefault "--markdown-by-default"} \ $baseJSON $options \ > $dst/options.json diff --git a/nixos/lib/make-options-doc/mergeJSON.py b/nixos/lib/make-options-doc/mergeJSON.py index 8a8498746bf6c..f8353a794b6a5 100644 --- a/nixos/lib/make-options-doc/mergeJSON.py +++ b/nixos/lib/make-options-doc/mergeJSON.py @@ -203,6 +203,9 @@ def convertMD(options: Dict[str, Any]) -> str: for (name, option) in options.items(): if optionIs(option, 'description', 'mdDoc'): option['description'] = convertString(name, option['description']['text']) + elif markdownByDefault: + option['description'] = convertString(name, option['description']) + if optionIs(option, 'example', 'literalMD'): docbook = convertString(name, option['example']['text']) option['example'] = { '_type': 'literalDocBook', 'text': docbook } @@ -214,6 +217,7 @@ def convertMD(options: Dict[str, Any]) -> str: warningsAreErrors = False errorOnDocbook = False +markdownByDefault = False optOffset = 0 for arg in sys.argv[1:]: if arg == "--warnings-are-errors": @@ -222,6 +226,9 @@ for arg in sys.argv[1:]: if arg == "--error-on-docbook": optOffset += 1 errorOnDocbook = True + if arg == "--markdown-by-default": + optOffset += 1 + markdownByDefault = True options = pivot(json.load(open(sys.argv[1 + optOffset], 'r'))) overrides = pivot(json.load(open(sys.argv[2 + optOffset], 'r'))) |