diff --git a/doc/doc-support/default.nix b/doc/doc-support/default.nix index 429c7a5fbe800..ec180064c35d8 100644 --- a/doc/doc-support/default.nix +++ b/doc/doc-support/default.nix @@ -3,8 +3,22 @@ let inherit (pkgs) lib; inherit (lib) hasPrefix removePrefix; - locationsXml = import ./lib-function-locations.nix { inherit pkgs nixpkgs; }; - functionDocs = import ./lib-function-docs.nix { inherit locationsXml pkgs; }; + libsets = [ + { name = "asserts"; description = "assertion functions"; } + { name = "attrsets"; description = "attribute set functions"; } + { name = "strings"; description = "string manipulation functions"; } + { name = "versions"; description = "version string functions"; } + { name = "trivial"; description = "miscellaneous functions"; } + { name = "lists"; description = "list manipulation functions"; } + { name = "debug"; description = "debugging functions"; } + { name = "options"; description = "NixOS / nixpkgs option handling"; } + { name = "filesystem"; description = "filesystem functions"; } + { name = "sources"; description = "source filtering functions"; } + { name = "cli"; description = "command-line serialization functions"; } + ]; + + locationsXml = import ./lib-function-locations.nix { inherit pkgs nixpkgs libsets; }; + functionDocs = import ./lib-function-docs.nix { inherit locationsXml pkgs libsets; }; version = pkgs.lib.version; epub-xsl = pkgs.writeText "epub.xsl" '' diff --git a/doc/doc-support/lib-function-docs.nix b/doc/doc-support/lib-function-docs.nix index 4e67609e23fb2..d6fa08aa96205 100644 --- a/doc/doc-support/lib-function-docs.nix +++ b/doc/doc-support/lib-function-docs.nix @@ -1,30 +1,32 @@ -# Generates the documentation for library functions via nixdoc. To add -# another library function file to this list, the include list in the -# file `doc/functions/library.xml` must also be updated. +# Generates the documentation for library functions via nixdoc. -{ pkgs ? import ./.. {}, locationsXml }: +{ pkgs, locationsXml, libsets }: with pkgs; stdenv.mkDerivation { name = "nixpkgs-lib-docs"; - src = ./../../lib; + src = ../../lib; buildInputs = [ nixdoc ]; installPhase = '' function docgen { - nixdoc -c "$1" -d "$2" -f "../lib/$1.nix" > "$out/$1.xml" + # TODO: wrap lib.$1 in , make nixdoc not escape it + nixdoc -c "$1" -d "lib.$1: $2" -f "$1.nix" > "$out/$1.xml" + echo "" >> "$out/index.xml" } - mkdir -p $out - ln -s ${locationsXml} $out/locations.xml + mkdir -p "$out" + + cat > "$out/index.xml" << 'EOF' + + + EOF + + ${lib.concatMapStrings ({ name, description }: '' + docgen ${name} ${lib.escapeShellArg description} + '') libsets} - docgen asserts 'Assert functions' - docgen attrsets 'Attribute-set functions' - docgen strings 'String manipulation functions' - docgen trivial 'Miscellaneous functions' - docgen lists 'List manipulation functions' - docgen debug 'Debugging functions' - docgen options 'NixOS / nixpkgs option handling' - docgen filesystem 'Filesystem functions' - docgen sources 'Source filtering functions' + echo "" >> "$out/index.xml" + + ln -s ${locationsXml} $out/locations.xml ''; } diff --git a/doc/doc-support/lib-function-locations.nix b/doc/doc-support/lib-function-locations.nix index 68edd27098543..ae1123c63ad30 100644 --- a/doc/doc-support/lib-function-locations.nix +++ b/doc/doc-support/lib-function-locations.nix @@ -1,4 +1,4 @@ -{ pkgs ? (import ./.. { }), nixpkgs ? { }}: +{ pkgs, nixpkgs ? { }, libsets }: let revision = pkgs.lib.trivial.revisionWithDefault (nixpkgs.revision or "master"); @@ -16,9 +16,7 @@ let subsetname = subsetname; functions = libDefPos toplib.${subsetname}; }) - (builtins.filter - (name: builtins.isAttrs toplib.${name}) - (builtins.attrNames toplib)); + (builtins.map (x: x.name) libsets); nixpkgsLib = pkgs.lib; diff --git a/doc/doc-support/parameters.xml b/doc/doc-support/parameters.xml index 50ff25fe10750..5b39d2f7f1a58 100644 --- a/doc/doc-support/parameters.xml +++ b/doc/doc-support/parameters.xml @@ -11,6 +11,7 @@ + diff --git a/doc/functions/library.xml b/doc/functions/library.xml index 0a8bae229f261..788ea0b94f1fe 100644 --- a/doc/functions/library.xml +++ b/doc/functions/library.xml @@ -8,25 +8,7 @@ Nixpkgs provides a standard library at pkgs.lib, or through import <nixpkgs/lib>. - - - - - - - - - - - - - - - - - - - + +