diff options
author | pennae <github@quasiparticle.net> | 2023-01-19 00:39:17 +0100 |
---|---|---|
committer | pennae <82953136+pennae@users.noreply.github.com> | 2023-01-22 17:50:09 +0100 |
commit | 248e1b957d07e4f45f0c279d0868932de3ce8563 (patch) | |
tree | 6ad65d6fb580e95ca2b138452204cd090151d7c8 /nixos | |
parent | fa8a594c56063f12d4c2d9dbae64421c45a4007b (diff) |
nixos/make-options-doc: render related packages with md
don't generate docbook for related packages, generate markdown instead. this could be extended further to not even generate markdown but have mergeJSON handle all of the rendering. markdown will work fine for now though.
Diffstat (limited to 'nixos')
-rw-r--r-- | nixos/lib/make-options-doc/default.nix | 15 | ||||
-rw-r--r-- | nixos/lib/make-options-doc/mergeJSON.py | 3 |
2 files changed, 9 insertions, 9 deletions
diff --git a/nixos/lib/make-options-doc/default.nix b/nixos/lib/make-options-doc/default.nix index 7595b66771a58..3a5e1f2023d58 100644 --- a/nixos/lib/make-options-doc/default.nix +++ b/nixos/lib/make-options-doc/default.nix @@ -78,16 +78,13 @@ let title = args.title or null; name = args.name or (lib.concatStringsSep "." args.path); in '' - <listitem> - <para> - <link xlink:href="https://search.nixos.org/packages?show=${name}&sort=relevance&query=${name}"> - <literal>${lib.optionalString (title != null) "${title} aka "}pkgs.${name}</literal> - </link> - </para> - ${lib.optionalString (args ? comment) "<para>${args.comment}</para>"} - </listitem> + - [`${lib.optionalString (title != null) "${title} aka "}pkgs.${name}`]( + https://search.nixos.org/packages?show=${name}&sort=relevance&query=${name} + )${ + lib.optionalString (args ? comment) "\n\n ${args.comment}" + } ''; - in "<itemizedlist>${lib.concatStringsSep "\n" (map (p: describe (unpack p)) packages)}</itemizedlist>"; + in lib.concatMapStrings (p: describe (unpack p)) packages; optionsNix = builtins.listToAttrs (map (o: { name = o.name; value = removeAttrs o ["name" "visible" "internal"]; }) optionsList); diff --git a/nixos/lib/make-options-doc/mergeJSON.py b/nixos/lib/make-options-doc/mergeJSON.py index e78056f3f59f6..686c57ef7be0e 100644 --- a/nixos/lib/make-options-doc/mergeJSON.py +++ b/nixos/lib/make-options-doc/mergeJSON.py @@ -239,6 +239,9 @@ def convertMD(options: Dict[str, Any]) -> str: convertCode(name, option, 'example') convertCode(name, option, 'default') + + if 'relatedPackages' in option: + option['relatedPackages'] = convertString(name, option['relatedPackages']) except Exception as e: raise Exception(f"Failed to render option {name}: {str(e)}") |