Merge pull request #6150 from GuillaumeDesforges/doc/builtins-functio…

…n-anchor Add anchor to builtin functions in HTML documentation
NixOS · Feb 24, 2022 · 3317866 · 3317866
2 parents 7ec244a + cfbf9ee
commit 3317866
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/doc/manual/generate-builtins.nix b/doc/manual/generate-builtins.nix
@@ -6,9 +6,9 @@ builtins:
 concatStrings (map
  (name:
  let builtin = builtins.${name}; in
- "<dt><code>${name} "
+ "<dt id=\"builtins-${name}\"><a href=\"#builtins-${name}\"><code>${name} "
  + concatStringsSep " " (map (s: "<var>${s}</var>") builtin.args)
- + "</code></dt>"
+ + "</code></a></dt>"
  + "<dd>\n\n"
  + builtin.doc
  + "\n\n</dd>"

diff --git a/doc/manual/local.mk b/doc/manual/local.mk
@@ -72,6 +72,7 @@ $(d)/builtins.json: $(bindir)/nix
  @mv $@.tmp $@
 
 # Generate the HTML manual.
+html: $(docdir)/manual/index.html
 install: $(docdir)/manual/index.html
 
 # Generate 'nix' manpages.