92179785b6
What I missed when I began using Nix and NixOS was a clear overview of how packages, channels, Hydra, the master branch and updates to channels relate to each other. I've noticed I am not the only one, given the amount of times these questions pop up. For now I propose to include this in the Nixpkgs manual, since this seems to be the best fit. However, I think it would be good to include this in either a new manual, i.e., a user manual, or an 'official' tutorial.
83 lines
2.3 KiB
Nix
83 lines
2.3 KiB
Nix
with import ./.. { };
|
|
with lib;
|
|
let
|
|
sources = sourceFilesBySuffices ./. [".xml"];
|
|
sources-langs = ./languages-frameworks;
|
|
in
|
|
stdenv.mkDerivation {
|
|
name = "nixpkgs-manual";
|
|
|
|
|
|
buildInputs = [ pandoc libxml2 libxslt ];
|
|
|
|
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 = ''xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" '';
|
|
in ''
|
|
{
|
|
pandoc '${inputFile}' -w docbook ${optionalString useChapters "--chapters"} \
|
|
| 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.md;
|
|
outputFile = "introduction.xml";
|
|
useChapters = true;
|
|
}
|
|
+ toDocbook {
|
|
inputFile = ./haskell-users-guide.md;
|
|
outputFile = "haskell-users-guide.xml";
|
|
useChapters = true;
|
|
}
|
|
+ toDocbook {
|
|
inputFile = ./../pkgs/development/idris-modules/README.md;
|
|
outputFile = "languages-frameworks/idris.xml";
|
|
}
|
|
+ ''
|
|
cat languages-frameworks/idris.xml
|
|
echo ${nixpkgsVersion} > .version
|
|
|
|
xmllint --noout --nonet --xinclude --noxincludenode \
|
|
--relaxng ${docbook5}/xml/rng/docbook/docbook.rng \
|
|
manual.xml
|
|
|
|
dst=$out/share/doc/nixpkgs
|
|
mkdir -p $dst
|
|
xsltproc $xsltFlags --nonet --xinclude \
|
|
--output $dst/manual.html \
|
|
${docbook5_xsl}/xml/xsl/docbook/xhtml/docbook.xsl \
|
|
./manual.xml
|
|
|
|
cp ${./style.css} $dst/style.css
|
|
|
|
mkdir -p $dst/images/callouts
|
|
cp "${docbook5_xsl}/xml/xsl/docbook/images/callouts/"*.gif $dst/images/callouts/
|
|
|
|
mkdir -p $out/nix-support
|
|
echo "doc manual $dst manual.html" >> $out/nix-support/hydra-build-products
|
|
'';
|
|
}
|