we no longer have to look like docbook-xslt generates our manuals exclusively, so let's put something useful in there instead.
200 lines
6.4 KiB
Nix
200 lines
6.4 KiB
Nix
{ pkgs
|
|
, options
|
|
, config
|
|
, version
|
|
, revision
|
|
, extraSources ? []
|
|
, baseOptionsJSON ? null
|
|
, warningsAreErrors ? true
|
|
, prefix ? ../../..
|
|
}:
|
|
|
|
with pkgs;
|
|
|
|
let
|
|
inherit (lib) hasPrefix removePrefix;
|
|
|
|
lib = pkgs.lib;
|
|
|
|
manpageUrls = pkgs.path + "/doc/manpage-urls.json";
|
|
|
|
# We need to strip references to /nix/store/* from options,
|
|
# including any `extraSources` if some modules came from elsewhere,
|
|
# or else the build will fail.
|
|
#
|
|
# E.g. if some `options` came from modules in ${pkgs.customModules}/nix,
|
|
# you'd need to include `extraSources = [ pkgs.customModules ]`
|
|
prefixesToStrip = map (p: "${toString p}/") ([ prefix ] ++ extraSources);
|
|
stripAnyPrefixes = lib.flip (lib.foldr lib.removePrefix) prefixesToStrip;
|
|
|
|
optionsDoc = buildPackages.nixosOptionsDoc {
|
|
inherit options revision baseOptionsJSON warningsAreErrors;
|
|
transformOptions = opt: opt // {
|
|
# Clean up declaration sites to not refer to the NixOS source tree.
|
|
declarations = map stripAnyPrefixes opt.declarations;
|
|
};
|
|
};
|
|
|
|
nixos-lib = import ../../lib { };
|
|
|
|
testOptionsDoc = let
|
|
eval = nixos-lib.evalTest {
|
|
# Avoid evaluating a NixOS config prototype.
|
|
config.node.type = lib.types.deferredModule;
|
|
options._module.args = lib.mkOption { internal = true; };
|
|
};
|
|
in buildPackages.nixosOptionsDoc {
|
|
inherit (eval) options;
|
|
inherit revision;
|
|
transformOptions = opt: opt // {
|
|
# Clean up declaration sites to not refer to the NixOS source tree.
|
|
declarations =
|
|
map
|
|
(decl:
|
|
if hasPrefix (toString ../../..) (toString decl)
|
|
then
|
|
let subpath = removePrefix "/" (removePrefix (toString ../../..) (toString decl));
|
|
in { url = "https://github.com/NixOS/nixpkgs/blob/master/${subpath}"; name = subpath; }
|
|
else decl)
|
|
opt.declarations;
|
|
};
|
|
documentType = "none";
|
|
variablelistId = "test-options-list";
|
|
optionIdPrefix = "test-opt-";
|
|
};
|
|
|
|
prepareManualFromMD = ''
|
|
cp -r --no-preserve=all $inputs/* .
|
|
|
|
substituteInPlace ./manual.md \
|
|
--replace '@NIXOS_VERSION@' "${version}"
|
|
substituteInPlace ./configuration/configuration.md \
|
|
--replace \
|
|
'@MODULE_CHAPTERS@' \
|
|
${lib.escapeShellArg (lib.concatMapStringsSep "\n" (p: "${p.value}") config.meta.doc)}
|
|
substituteInPlace ./nixos-options.md \
|
|
--replace \
|
|
'@NIXOS_OPTIONS_JSON@' \
|
|
${optionsDoc.optionsJSON}/share/doc/nixos/options.json
|
|
substituteInPlace ./development/writing-nixos-tests.section.md \
|
|
--replace \
|
|
'@NIXOS_TEST_OPTIONS_JSON@' \
|
|
${testOptionsDoc.optionsJSON}/share/doc/nixos/options.json
|
|
'';
|
|
|
|
in rec {
|
|
inherit (optionsDoc) optionsJSON optionsNix optionsDocBook;
|
|
|
|
# Generate the NixOS manual.
|
|
manualHTML = runCommand "nixos-manual-html"
|
|
{ nativeBuildInputs = [ buildPackages.nixos-render-docs ];
|
|
inputs = lib.sourceFilesBySuffices ./. [ ".md" ];
|
|
meta.description = "The NixOS manual in HTML format";
|
|
allowedReferences = ["out"];
|
|
}
|
|
''
|
|
# Generate the HTML manual.
|
|
dst=$out/share/doc/nixos
|
|
mkdir -p $dst
|
|
|
|
cp ${../../../doc/style.css} $dst/style.css
|
|
cp ${../../../doc/overrides.css} $dst/overrides.css
|
|
cp -r ${pkgs.documentation-highlighter} $dst/highlightjs
|
|
|
|
${prepareManualFromMD}
|
|
|
|
nixos-render-docs -j $NIX_BUILD_CORES manual html \
|
|
--manpage-urls ${manpageUrls} \
|
|
--revision ${lib.escapeShellArg revision} \
|
|
--generator "nixos-render-docs ${lib.version}" \
|
|
--stylesheet style.css \
|
|
--stylesheet overrides.css \
|
|
--stylesheet highlightjs/mono-blue.css \
|
|
--script ./highlightjs/highlight.pack.js \
|
|
--script ./highlightjs/loader.js \
|
|
--toc-depth 1 \
|
|
--chunk-toc-depth 1 \
|
|
./manual.md \
|
|
$dst/index.html
|
|
|
|
mkdir -p $out/nix-support
|
|
echo "nix-build out $out" >> $out/nix-support/hydra-build-products
|
|
echo "doc manual $dst" >> $out/nix-support/hydra-build-products
|
|
''; # */
|
|
|
|
# Alias for backward compatibility. TODO(@oxij): remove eventually.
|
|
manual = manualHTML;
|
|
|
|
# Index page of the NixOS manual.
|
|
manualHTMLIndex = "${manualHTML}/share/doc/nixos/index.html";
|
|
|
|
manualEpub = runCommand "nixos-manual-epub"
|
|
{ nativeBuildInputs = [ buildPackages.libxml2.bin buildPackages.libxslt.bin buildPackages.zip ];
|
|
doc = ''
|
|
<book xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
version="5.0"
|
|
xml:id="book-nixos-manual">
|
|
<info>
|
|
<title>NixOS Manual</title>
|
|
<subtitle>Version ${lib.version}</subtitle>
|
|
</info>
|
|
<chapter>
|
|
<title>Temporarily unavailable</title>
|
|
<para>
|
|
The NixOS manual is currently not available in EPUB format,
|
|
please use the <link xlink:href="https://nixos.org/nixos/manual">HTML manual</link>
|
|
instead.
|
|
</para>
|
|
<para>
|
|
If you've used the EPUB manual in the past and it has been useful to you, please
|
|
<link xlink:href="https://github.com/NixOS/nixpkgs/issues/237234">let us know</link>.
|
|
</para>
|
|
</chapter>
|
|
</book>
|
|
'';
|
|
passAsFile = [ "doc" ];
|
|
}
|
|
''
|
|
# Generate the epub manual.
|
|
dst=$out/share/doc/nixos
|
|
|
|
xsltproc \
|
|
--param chapter.autolabel 0 \
|
|
--nonet --xinclude --output $dst/epub/ \
|
|
${docbook_xsl_ns}/xml/xsl/docbook/epub/docbook.xsl \
|
|
$docPath
|
|
|
|
echo "application/epub+zip" > mimetype
|
|
manual="$dst/nixos-manual.epub"
|
|
zip -0Xq "$manual" mimetype
|
|
cd $dst/epub && zip -Xr9D "$manual" *
|
|
|
|
rm -rf $dst/epub
|
|
|
|
mkdir -p $out/nix-support
|
|
echo "doc-epub manual $manual" >> $out/nix-support/hydra-build-products
|
|
'';
|
|
|
|
|
|
# Generate the NixOS manpages.
|
|
manpages = runCommand "nixos-manpages"
|
|
{ nativeBuildInputs = [
|
|
buildPackages.installShellFiles
|
|
buildPackages.nixos-render-docs
|
|
];
|
|
allowedReferences = ["out"];
|
|
}
|
|
''
|
|
# Generate manpages.
|
|
mkdir -p $out/share/man/man8
|
|
installManPage ${./manpages}/*
|
|
mkdir -p $out/share/man/man5
|
|
nixos-render-docs -j $NIX_BUILD_CORES options manpage \
|
|
--revision ${lib.escapeShellArg revision} \
|
|
${optionsJSON}/share/doc/nixos/options.json \
|
|
$out/share/man/man5/configuration.nix.5
|
|
'';
|
|
|
|
}
|