mirror of
https://github.com/NotAShelf/nvf.git
synced 2026-06-22 12:33:29 +00:00
d390177b7f
Some checks are pending
Set up binary cache / cachix (default) (push) Waiting to run
Set up binary cache / cachix (maximal) (push) Waiting to run
Set up binary cache / cachix (nix) (push) Waiting to run
Treewide Checks / Validate flake (push) Waiting to run
Treewide Checks / Check formatting (push) Waiting to run
Treewide Checks / Check source tree for typos (push) Waiting to run
Treewide Checks / Validate documentation builds (push) Waiting to run
Treewide Checks / Validate documentation builds-1 (push) Waiting to run
Treewide Checks / Validate documentation builds-2 (push) Waiting to run
Treewide Checks / Validate documentation builds-3 (push) Waiting to run
Treewide Checks / Validate hyperlinks in documentation sources (push) Waiting to run
Treewide Checks / Validate Editorconfig conformance (push) Waiting to run
Build and deploy documentation / Check latest commit (push) Waiting to run
Build and deploy documentation / publish (push) Blocked by required conditions
74 lines
2.1 KiB
Nix
74 lines
2.1 KiB
Nix
{
|
|
path,
|
|
stdenvNoCC,
|
|
optionsJSON,
|
|
jaq,
|
|
ndg,
|
|
gnused,
|
|
} @ args: let
|
|
manual-release = args.release or "unstable";
|
|
in
|
|
stdenvNoCC.mkDerivation (finalAttrs: {
|
|
pname = "nvf-docs-html";
|
|
version = manual-release;
|
|
src = ./manual;
|
|
|
|
nativeBuildInputs = [
|
|
ndg
|
|
jaq
|
|
gnused
|
|
];
|
|
|
|
patchPhase = ''
|
|
# Replace variables following the @VARIABLE@ style in the manual
|
|
# pages. This can be built into ndg at a later date.
|
|
substituteInPlace index.md \
|
|
--subst-var-by NVF_VERSION ${finalAttrs.version}
|
|
|
|
language_options=$(cat "${optionsJSON}/share/doc/nixos/options.json" | jaq -r 'keys
|
|
| map(select(test("^vim\\.languages\\.[^.]+\\.enable$")))
|
|
| map("- {option}`" + . + "`")
|
|
| join("\n")'
|
|
)
|
|
|
|
substituteInPlace configuring/languages.md \
|
|
--subst-var-by NVF_LANGUAGES_ENABLE "$language_options"
|
|
'';
|
|
|
|
buildPhase = ''
|
|
mkdir -p queries/nix
|
|
|
|
# apply nix injections
|
|
sed -n -f /dev/stdin ${../modules/plugins/languages/nix.nix} <<'EOF' > ./queries/nix/injections.scm
|
|
/type = "injections"/,/^[[:space:]]*};/ {
|
|
/query = '''/,/^[[:space:]]*''';/ {
|
|
/query = '''/d
|
|
/^[[:space:]]*''';/d
|
|
p
|
|
}
|
|
}
|
|
EOF
|
|
|
|
# Syntactica doesnt support `query` so we patch it with the closest it does,
|
|
# which is `haskell` :bwaa:
|
|
sed -i 's|#set! injection\.language "query"|#set! injection.language "haskell"|' ./queries/nix/injections.scm
|
|
|
|
# Generate the final manual from a set of parameters. This uses
|
|
# feel-co/ndg to render the web manual.
|
|
ndg --config-file ${./ndg.toml} html \
|
|
--jobs $NIX_BUILD_CORES --title "NVF" \
|
|
--module-options ${optionsJSON}/share/doc/nixos/options.json \
|
|
--manpage-urls ${path}/doc/manpage-urls.json \
|
|
--input-dir . \
|
|
--output-dir build
|
|
'';
|
|
|
|
installPhase = ''
|
|
mkdir -p $out/share/doc
|
|
cp -r build/* $out/share/doc/
|
|
|
|
# Hydra support. Probably not necessary.
|
|
mkdir -p $out/nix-support/
|
|
echo "doc manual $out/share/doc index.html" >> $out/nix-support/hydra-build-products
|
|
'';
|
|
})
|