From f0fd252dd0a7df26899282a102f397136d508228 Mon Sep 17 00:00:00 2001 From: Alex David Date: Sat, 7 Jun 2025 14:36:51 -0700 Subject: [PATCH] Add links to combinator implementations in docs --- website/flake.nix | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/website/flake.nix b/website/flake.nix index 420b16c..af6724a 100644 --- a/website/flake.nix +++ b/website/flake.nix @@ -3,10 +3,24 @@ # want to depend on nixpkgs inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-25.05"; - outputs = { nixpkgs, ... }: let + outputs = { self, nixpkgs, ... }: let pkgs = import nixpkgs { system = "x86_64-linux"; }; lib = pkgs.lib; + formatCombinatorDoc = name: combinatorObj: let + attrPos = builtins.unsafeGetAttrPos "impl" combinatorObj; + file = lib.removePrefix (toString ./..) attrPos.file; + in '' + ## ${name} + **${name} :: ${combinatorObj.sig}** + + ${if self ? rev then "[Source](https://git.sr.ht/~alexdavid/jail.nix/tree/${self.rev}${file}#L${toString attrPos.line})" else ""} + + ${combinatorObj.doc} + + --- + ''; + combinatorDocs = lib.pipe { pkgs = throw "Docs must not depend on pkgs"; @@ -16,7 +30,7 @@ [ (import ../combinators.nix) (lib.filterAttrs (_: v: !(v ? deprecated && v.deprecated))) - (lib.mapAttrsToList (k: v: "## ${k}\n**${k} :: ${v.sig}**\n\n${v.doc}")) + (lib.mapAttrsToList formatCombinatorDoc) (lib.concatStringsSep "\n\n") (docs: "# Combinators\n\n${docs}") ];