mirror of
https://github.com/NotAShelf/nvf.git
synced 2025-10-01 22:43:32 +00:00
NotAShelf
b9dd1b816a
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I6a6a6964afba43bdda6a2cbf037404ca3fa4f8c9
49 lines
1.5 KiB
Nix
49 lines
1.5 KiB
Nix
{
|
|
inputs,
|
|
path,
|
|
stdenvNoCC,
|
|
runCommandNoCCLocal,
|
|
optionsJSON,
|
|
} @ args: let
|
|
manual-release = args.release or "unstable";
|
|
in
|
|
runCommandNoCCLocal "nvf-docs-html" {
|
|
nativeBuildInputs = [
|
|
(inputs.ndg.packages.${stdenvNoCC.system}.ndg.overrideAttrs
|
|
{
|
|
# FIXME: the tests take too long to build
|
|
doCheck = false;
|
|
})
|
|
];
|
|
} ''
|
|
mkdir -p $out/share/doc
|
|
|
|
# Copy the markdown sources to be processed by ndg. This is not
|
|
# strictly necessary, but allows us to modify the Markdown sources
|
|
# as we see fit.
|
|
cp -rvf ${./manual} ./manual
|
|
|
|
# Replace variables following the @VARIABLE@ style in the manual
|
|
# pages. This can be built into ndg at a later date.
|
|
substituteInPlace ./manual/index.md \
|
|
--subst-var-by NVF_VERSION ${manual-release}
|
|
|
|
substituteInPlace ./manual/hacking/additional-plugins.md \
|
|
--subst-var-by NVF_REPO "https://github.com/notashelf/nvf/blob/${manual-release}"
|
|
|
|
# Generate the final manual from a set of parameters. This uses
|
|
# feel-co/ndg to render the web manual.
|
|
ndg html \
|
|
--jobs $NIX_BUILD_CORES --title "NVF" \
|
|
--module-options ${optionsJSON}/share/doc/nixos/options.json \
|
|
--manpage-urls ${path}/doc/manpage-urls.json \
|
|
--options-depth 3 \
|
|
--generate-search true \
|
|
--highlight-code true \
|
|
--input-dir ./manual \
|
|
--output-dir "$out/share/doc"
|
|
|
|
# Hydra support. Probably not necessary.
|
|
mkdir -p $out/nix-support/
|
|
echo "doc manual $dest index.html" >> $out/nix-support/hydra-build-products
|
|
''
|