From 4cbeb4e4919c12a133fee56e995b5a92b381c85e Mon Sep 17 00:00:00 2001 From: Alex Tau Date: Sat, 10 May 2025 16:45:48 +0300 Subject: [PATCH] replace links in autogenerated docs for better viewing on gitlab --- docs/nixos-options.md | 32 ++++++++++++++++---------------- mkdocs.nix | 5 ++++- 2 files changed, 20 insertions(+), 17 deletions(-) diff --git a/docs/nixos-options.md b/docs/nixos-options.md index df3c918..7fc56f5 100644 --- a/docs/nixos-options.md +++ b/docs/nixos-options.md @@ -20,7 +20,7 @@ boolean ` true ` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -41,7 +41,7 @@ list of (one of “start”, “stop”, “temp”, “vulnix”) ` [ ] ` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -84,7 +84,7 @@ attribute set of (submodule) ``` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -105,7 +105,7 @@ boolean ` true ` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -126,7 +126,7 @@ null or string ` null ` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -147,7 +147,7 @@ attribute set of (submodule) ` { } ` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -168,7 +168,7 @@ boolean ` true ` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -189,7 +189,7 @@ null or floating point number ` null ` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -210,7 +210,7 @@ null or string ` null ` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -231,7 +231,7 @@ null or floating point number ` null ` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -266,7 +266,7 @@ attribute set of (submodule) ``` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -288,7 +288,7 @@ null or (list of string) ` null ` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -309,7 +309,7 @@ null or string ` null ` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -331,7 +331,7 @@ null or string ` null ` *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -347,7 +347,7 @@ Path to a file containing Telegram api_id, api_hash, and bot token, separated by string *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) @@ -363,6 +363,6 @@ ID of chat where to send alerts\. signed integer *Declared by:* - - [/nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options\.nix](file:///nix/store/jm7cx941zr5pl113s5nxvfqpaqf89ysl-source/modules/options.nix) + - [../modules/options\.nix](../modules/options.nix) diff --git a/mkdocs.nix b/mkdocs.nix index 6a38c55..a82a16c 100644 --- a/mkdocs.nix +++ b/mkdocs.nix @@ -11,5 +11,8 @@ let optionsDoc = pkgs.nixosOptionsDoc { options = builtins.removeAttrs optEval.options [ "_module" ]; }; + replaceLinkNamesPattern = ''sR\[/nix/store/[a-z0-9]+-source/R[../R''; + replaceLinkContentsPattern = ''sR\(file:///nix/store/[a-z0-9]+-source/R(../R''; in - pkgs.runCommand "options-doc.md" {} "cat ${optionsDoc.optionsCommonMark} >> $out" + pkgs.runCommand "options-doc.md" {} '' + sed -r '${replaceLinkNamesPattern};${replaceLinkContentsPattern}' '${optionsDoc.optionsCommonMark}' >> $out''