diff --git a/docs/manual.nix b/docs/manual.nix index 1ce89126..bf222204 100644 --- a/docs/manual.nix +++ b/docs/manual.nix @@ -1,32 +1,38 @@ { inputs, - stdenvNoCC, - runCommandLocal, - # build inputs path, - # nrd configuration - release, + stdenvNoCC, + runCommandNoCCLocal, optionsJSON, } @ args: let manual-release = args.release or "unstable"; in - runCommandLocal "hjem-docs" { - nativeBuildInputs = [inputs.ndg.packages.${stdenvNoCC.system}.ndg]; + 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 + # 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 - substituteInPlace ./manual/options.md \ - --subst-var-by OPTIONS_JSON ./config-options.json - + # 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 \ @@ -41,78 +47,3 @@ in mkdir -p $out/nix-support/ echo "doc manual $dest index.html" >> $out/nix-support/hydra-build-products '' -/* -stdenvNoCC.mkDerivation { - name = "nvf-manual"; - src = builtins.path { - name = "nvf-manual-${manual-release}"; - path = lib.sourceFilesBySuffices ./manual [".md" ".md.in"]; - }; - - strictDependencies = true; - nativeBuildInputs = [nixos-render-docs]; - - postPatch = '' - ln -s ${optionsJSON}/share/doc/nixos/options.json ./config-options.json - ''; - - buildPhase = '' - dest="$out/share/doc/nvf" - mkdir -p "$(dirname "$dest")" - mkdir -p $dest/{highlightjs,script} - - # Copy highlight scripts to /highlights in document root. - cp -vt $dest/highlightjs \ - ${documentation-highlighter}/highlight.pack.js \ - ${documentation-highlighter}/LICENSE \ - ${documentation-highlighter}/mono-blue.css \ - ${documentation-highlighter}/loader.js - - # Copy anchor scripts to the script directory in document root. - cp -vt "$dest"/script \ - ${./static/script}/anchor-min.js \ - ${./static/script}/anchor-use.js \ - ${./static/script}/search.js - - - - # Move compiled stylesheet - cp -vt $dest \ - ${compileStylesheet}/style.css - - # Move release notes - cp -vr ${./release-notes} release-notes - - # Generate final manual from a set of parameters. Explanation of the CLI flags are - # as follows: - # - # 1. --manpage-urls will allow you to use manual pages as they are defined in - # the nixpkgs documentation. - # 2. --revision is the project revision as it is defined in 'release.json' in the - # repository root - # 3. --script will inject a given Javascript file into the resulting pages inside - # the