gador/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: render nixpkgs manual with nrd

Browse Source 
also updates nixdoc to 2.3.0. the nixdoc update is not a separate commit
because that would leave the manual build broken for one commit,
potentially breaking bisects and rebases.
This commit is contained in:
pennae
2023-03-25 21:38:26 +01:00
parent b521f451a3
commit be4d19ff1a
34 changed files with 395 additions and 729 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
doc/doc-support/lib-function-docs.nix
View File

@@ -5,7 +5,7 @@
with pkgs;
let
locationsXml = import ./lib-function-locations.nix { inherit pkgs nixpkgs libsets; };
locationsJSON = import ./lib-function-locations.nix { inherit pkgs nixpkgs libsets; };
in
stdenv.mkDerivation {
name = "nixpkgs-lib-docs";
@@ -16,26 +16,23 @@ stdenv.mkDerivation {
function docgen {
# TODO: wrap lib.$1 in <literal>, make nixdoc not escape it
if [[ -e "../lib/$1.nix" ]]; then
nixdoc -c "$1" -d "lib.$1: $2" -f "$1.nix" > "$out/$1.xml"
nixdoc -c "$1" -d "lib.$1: $2" -l ${locationsJSON} -f "$1.nix" > "$out/$1.md"
else
nixdoc -c "$1" -d "lib.$1: $2" -f "$1/default.nix" > "$out/$1.xml"
nixdoc -c "$1" -d "lib.$1: $2" -l ${locationsJSON} -f "$1/default.nix" > "$out/$1.md"
fi
echo "<xi:include href='$1.xml' />" >> "$out/index.xml"
echo "$out/$1.md" >> "$out/index.md"
}
mkdir -p "$out"
cat > "$out/index.xml" << 'EOF'
<?xml version="1.0" encoding="utf-8"?>
<root xmlns:xi="http://www.w3.org/2001/XInclude">
cat > "$out/index.md" << 'EOF'
```{=include=} sections
EOF
${lib.concatMapStrings ({ name, description }: ''
docgen ${name} ${lib.escapeShellArg description}
'') libsets}
echo "</root>" >> "$out/index.xml"
ln -s ${locationsXml} $out/locations.xml
echo '```' >> "$out/index.md"
'';
}