nixpkgs/doc/default.nix

123 lines
3.8 KiB
Nix
Raw Normal View History

let
pkgs = import ./.. { };
lib = pkgs.lib;
sources = lib.sourceFilesBySuffices ./. [".xml"];
sources-langs = ./languages-frameworks;
in
pkgs.stdenv.mkDerivation {
name = "nixpkgs-manual";
buildInputs = with pkgs; [ pandoc libxml2 libxslt zip ];
xsltFlags = ''
--param section.autolabel 1
--param section.label.includes.component.label 1
--param html.stylesheet 'style.css'
--param xref.with.number.and.title 1
--param toc.section.depth 3
--param admon.style '''
--param callout.graphics.extension '.gif'
'';
buildCommand = let toDocbook = { useChapters ? false, inputFile, outputFile }:
let
extraHeader = lib.optionalString (!useChapters)
''xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" '';
in ''
{
pandoc '${inputFile}' -w docbook+smart ${lib.optionalString useChapters "--top-level-division=chapter"} \
-f markdown+smart \
| sed -e 's|<ulink url=|<link xlink:href=|' \
-e 's|</ulink>|</link>|' \
-e 's|<sect. id=|<section xml:id=|' \
-e 's|</sect[0-9]>|</section>|' \
-e '1s| id=| xml:id=|' \
-e '1s|\(<[^ ]* \)|\1${extraHeader}|'
} > '${outputFile}'
'';
in
''
ln -s '${sources}/'*.xml .
mkdir ./languages-frameworks
cp -s '${sources-langs}'/* ./languages-frameworks
''
+ toDocbook {
inputFile = ./introduction.chapter.md;
outputFile = "introduction.chapter.xml";
useChapters = true;
}
2017-12-20 23:42:07 +00:00
+ toDocbook {
inputFile = ./shell.section.md;
outputFile = "shell.section.xml";
2017-12-20 23:42:07 +00:00
}
+ toDocbook {
inputFile = ./languages-frameworks/python.section.md;
outputFile = "./languages-frameworks/python.section.xml";
}
+ toDocbook {
inputFile = ./languages-frameworks/haskell.section.md;
outputFile = "./languages-frameworks/haskell.section.xml";
}
+ toDocbook {
inputFile = ./languages-frameworks/idris.section.md;
outputFile = "languages-frameworks/idris.section.xml";
}
+ toDocbook {
inputFile = ./languages-frameworks/node.section.md;
outputFile = "languages-frameworks/node.section.xml";
}
+ toDocbook {
inputFile = ./languages-frameworks/r.section.md;
outputFile = "languages-frameworks/r.section.xml";
}
2017-03-20 19:41:37 +00:00
+ toDocbook {
inputFile = ./languages-frameworks/rust.section.md;
outputFile = "./languages-frameworks/rust.section.xml";
2017-03-20 19:41:37 +00:00
}
+ toDocbook {
inputFile = ./languages-frameworks/vim.section.md;
outputFile = "./languages-frameworks/vim.section.xml";
}
+ toDocbook {
inputFile = ./languages-frameworks/emscripten.section.md;
outputFile = "./languages-frameworks/emscripten.section.xml";
}
+ ''
echo ${lib.nixpkgsVersion} > .version
# validate against relaxng schema
xmllint --nonet --xinclude --noxincludenode manual.xml --output manual-full.xml
${pkgs.jing}/bin/jing ${pkgs.docbook5}/xml/rng/docbook/docbook.rng manual-full.xml
dst=$out/share/doc/nixpkgs
mkdir -p $dst
xsltproc $xsltFlags --nonet --xinclude \
--output $dst/manual.html \
${pkgs.docbook5_xsl}/xml/xsl/docbook/xhtml/docbook.xsl \
./manual.xml
cp ${./style.css} $dst/style.css
2015-06-30 09:04:46 +00:00
mkdir -p $dst/images/callouts
cp "${pkgs.docbook5_xsl}/xml/xsl/docbook/images/callouts/"*.gif $dst/images/callouts/
2015-06-30 09:04:46 +00:00
mkdir -p $out/nix-support
echo "doc manual $dst manual.html" >> $out/nix-support/hydra-build-products
xsltproc $xsltFlags --nonet --xinclude \
--output $dst/epub/ \
${pkgs.docbook5_xsl}/xml/xsl/docbook/epub/docbook.xsl \
./manual.xml
cp -r $dst/images $dst/epub/OEBPS
echo "application/epub+zip" > mimetype
manual="$dst/nixpkgs-manual.epub"
zip -0Xq "$manual" mimetype
cd $dst/epub && zip -Xr9D "$manual" *
rm -rf $dst/epub
'';
}