nixpkgs/doc/default.nix

52 lines
1.8 KiB
Nix
Raw Normal View History

{ pkgs ? (import ./.. { }), nixpkgs ? { }}:
let
lib = pkgs.lib;
locationsXml = import ./lib-function-locations.nix { inherit pkgs nixpkgs; };
functionDocs = import ./lib-function-docs.nix { inherit locationsXml pkgs; };
in pkgs.stdenv.mkDerivation {
name = "nixpkgs-manual";
2018-05-01 02:35:54 +00:00
buildInputs = with pkgs; [ pandoc libxml2 libxslt zip jing xmlformat ];
2018-03-24 15:36:10 +00:00
src = ./.;
2018-03-26 12:24:27 +00:00
# Hacking on these variables? Make sure to close and open
# nix-shell between each test, maybe even:
# $ nix-shell --run "make clean all"
# otherwise they won't reapply :)
HIGHLIGHTJS = pkgs.documentation-highlighter;
XSL = "${pkgs.docbook_xsl_ns}/xml/xsl";
2018-03-24 15:36:10 +00:00
RNG = "${pkgs.docbook5}/xml/rng/docbook/docbook.rng";
2018-05-01 02:35:54 +00:00
XMLFORMAT_CONFIG = ../nixos/doc/xmlformat.conf;
2018-03-24 15:36:10 +00:00
xsltFlags = lib.concatStringsSep " " [
"--param section.autolabel 1"
"--param section.label.includes.component.label 1"
2018-03-26 12:24:27 +00:00
"--stringparam html.stylesheet 'style.css overrides.css highlightjs/mono-blue.css'"
"--stringparam html.script './highlightjs/highlight.pack.js ./highlightjs/loader.js'"
2018-03-24 15:36:10 +00:00
"--param xref.with.number.and.title 1"
"--param toc.section.depth 3"
2018-03-26 18:04:19 +00:00
"--stringparam admon.style ''"
"--stringparam callout.graphics.extension .svg"
2018-03-24 15:36:10 +00:00
];
postPatch = ''
rm -rf ./functions/library/locations.xml
ln -s ${locationsXml} ./functions/library/locations.xml
ln -s ${functionDocs} ./functions/library/generated
echo ${lib.version} > .version
2018-03-24 15:36:10 +00:00
'';
2018-03-24 15:36:10 +00:00
installPhase = ''
dest="$out/share/doc/nixpkgs"
mkdir -p "$(dirname "$dest")"
mv out/html "$dest"
mv "$dest/index.html" "$dest/manual.html"
2018-03-24 15:36:10 +00:00
mv out/epub/manual.epub "$dest/nixpkgs-manual.epub"
2018-03-24 15:36:10 +00:00
mkdir -p $out/nix-support/
echo "doc manual $dest manual.html" >> $out/nix-support/hydra-build-products
echo "doc manual $dest nixpkgs-manual.epub" >> $out/nix-support/hydra-build-products
'';
}