mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-12-29 17:14:33 +00:00
123 lines
3.5 KiB
Nix
123 lines
3.5 KiB
Nix
# This file describes the Nixpkgs manual, which happens to use module docs infra originally
|
|
# developed for NixOS. To build this derivation, run `nix-build -A nixpkgs-manual`.
|
|
#
|
|
{
|
|
lib,
|
|
stdenvNoCC,
|
|
callPackage,
|
|
devmode,
|
|
mkShellNoCC,
|
|
documentation-highlighter,
|
|
nixos-render-docs,
|
|
nixos-render-docs-redirects,
|
|
writeShellScriptBin,
|
|
nixpkgs ? { },
|
|
}:
|
|
|
|
stdenvNoCC.mkDerivation (
|
|
finalAttrs:
|
|
let
|
|
inherit (finalAttrs.finalPackage.optionsDoc) optionsJSON;
|
|
inherit (finalAttrs.finalPackage) epub lib-docs pythonInterpreterTable;
|
|
in
|
|
{
|
|
name = "nixpkgs-manual";
|
|
|
|
nativeBuildInputs = [ nixos-render-docs ];
|
|
|
|
src = lib.fileset.toSource {
|
|
root = ../.;
|
|
fileset = lib.fileset.unions [
|
|
(lib.fileset.fileFilter (file: file.hasExt "md" || file.hasExt "md.in") ../.)
|
|
../style.css
|
|
../anchor-use.js
|
|
../anchor.min.js
|
|
../manpage-urls.json
|
|
../redirects.json
|
|
];
|
|
};
|
|
|
|
postPatch = ''
|
|
ln -s ${optionsJSON}/share/doc/nixos/options.json ./config-options.json
|
|
'';
|
|
|
|
buildPhase = ''
|
|
substituteInPlace ./languages-frameworks/python.section.md \
|
|
--subst-var-by python-interpreter-table "$(<"${pythonInterpreterTable}")"
|
|
|
|
cat \
|
|
./functions/library.md.in \
|
|
${lib-docs}/index.md \
|
|
> ./functions/library.md
|
|
substitute ./manual.md.in ./manual.md \
|
|
--replace-fail '@MANUAL_VERSION@' '${lib.version}'
|
|
|
|
mkdir -p out/media
|
|
|
|
mkdir -p out/highlightjs
|
|
cp -t out/highlightjs \
|
|
${documentation-highlighter}/highlight.pack.js \
|
|
${documentation-highlighter}/LICENSE \
|
|
${documentation-highlighter}/mono-blue.css \
|
|
${documentation-highlighter}/loader.js
|
|
|
|
cp -t out ./style.css ./anchor.min.js ./anchor-use.js
|
|
|
|
nixos-render-docs manual html \
|
|
--manpage-urls ./manpage-urls.json \
|
|
--redirects ./redirects.json \
|
|
--revision ${nixpkgs.rev or "master"} \
|
|
--stylesheet style.css \
|
|
--stylesheet highlightjs/mono-blue.css \
|
|
--script ./highlightjs/highlight.pack.js \
|
|
--script ./highlightjs/loader.js \
|
|
--script ./anchor.min.js \
|
|
--script ./anchor-use.js \
|
|
--toc-depth 1 \
|
|
--section-toc-depth 1 \
|
|
manual.md \
|
|
out/index.html
|
|
'';
|
|
|
|
installPhase = ''
|
|
dest="$out/share/doc/nixpkgs"
|
|
mkdir -p "$(dirname "$dest")"
|
|
mv out "$dest"
|
|
mv "$dest/index.html" "$dest/manual.html"
|
|
|
|
cp ${epub} "$dest/nixpkgs-manual.epub"
|
|
|
|
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
|
|
'';
|
|
|
|
passthru = {
|
|
lib-docs = callPackage ./lib-function-docs.nix { inherit nixpkgs; };
|
|
|
|
epub = callPackage ./epub.nix { };
|
|
|
|
optionsDoc = callPackage ./options-doc.nix { };
|
|
|
|
pythonInterpreterTable = callPackage ./python-interpreter-table.nix { };
|
|
|
|
shell =
|
|
let
|
|
devmode' = devmode.override {
|
|
buildArgs = "./.";
|
|
open = "/share/doc/nixpkgs/manual.html";
|
|
};
|
|
nixos-render-docs-redirects' = writeShellScriptBin "redirects" "${lib.getExe nixos-render-docs-redirects} --file ${toString ../redirects.json} $@";
|
|
in
|
|
mkShellNoCC {
|
|
packages = [
|
|
devmode'
|
|
nixos-render-docs-redirects'
|
|
];
|
|
};
|
|
|
|
tests.manpage-urls = callPackage ../tests/manpage-urls.nix { };
|
|
};
|
|
}
|
|
)
|