2016-09-20 14:31:23 +00:00
|
|
|
ifeq ($(doc_generate),yes)
|
|
|
|
|
2020-07-22 18:27:23 +00:00
|
|
|
MANUAL_SRCS := $(call rwildcard, $(d)/src, *.md)
|
2014-02-01 10:30:21 +00:00
|
|
|
|
|
|
|
# Generate man pages.
|
|
|
|
man-pages := $(foreach n, \
|
2020-08-17 17:33:18 +00:00
|
|
|
nix-env.1 nix-build.1 nix-shell.1 nix-store.1 nix-instantiate.1 nix.1 \
|
2020-07-23 11:09:30 +00:00
|
|
|
nix-collect-garbage.1 \
|
|
|
|
nix-prefetch-url.1 nix-channel.1 \
|
|
|
|
nix-hash.1 nix-copy-closure.1 \
|
|
|
|
nix.conf.5 nix-daemon.8, \
|
2014-02-01 10:30:21 +00:00
|
|
|
$(d)/$(n))
|
2014-09-16 13:29:55 +00:00
|
|
|
|
2014-02-01 11:23:14 +00:00
|
|
|
clean-files += $(d)/*.1 $(d)/*.5 $(d)/*.8
|
2014-02-01 10:30:21 +00:00
|
|
|
|
2014-02-01 15:30:24 +00:00
|
|
|
dist-files += $(man-pages)
|
2014-02-01 14:18:48 +00:00
|
|
|
|
2020-07-23 11:09:30 +00:00
|
|
|
$(d)/%.1: $(d)/src/command-ref/%.md
|
|
|
|
$(trace-gen) lowdown -sT man $^ -o $@
|
|
|
|
|
|
|
|
$(d)/%.8: $(d)/src/command-ref/%.md
|
2020-07-22 18:27:23 +00:00
|
|
|
$(trace-gen) lowdown -sT man $^ -o $@
|
2014-02-01 10:30:21 +00:00
|
|
|
|
2020-07-23 08:56:15 +00:00
|
|
|
$(d)/nix.conf.5: $(d)/src/command-ref/conf-file.md
|
|
|
|
$(trace-gen) lowdown -sT man $^ -o $@
|
|
|
|
|
2020-08-17 17:33:18 +00:00
|
|
|
$(d)/src/command-ref/nix.md: $(d)/nix.json $(d)/generate-manpage.jq
|
|
|
|
jq -r -f doc/manual/generate-manpage.jq $< > $@
|
|
|
|
|
2020-08-19 16:28:04 +00:00
|
|
|
$(d)/src/command-ref/conf-file.md: $(d)/conf-file.json $(d)/generate-options.jq $(d)/src/command-ref/conf-file-prefix.md
|
|
|
|
cat doc/manual/src/command-ref/conf-file-prefix.md > $@
|
|
|
|
jq -r -f doc/manual/generate-options.jq $< >> $@
|
|
|
|
|
2020-08-17 17:33:18 +00:00
|
|
|
$(d)/nix.json: $(bindir)/nix
|
2020-08-24 12:49:30 +00:00
|
|
|
$(trace-gen) $(bindir)/nix __dump-args > $@
|
2020-08-17 17:33:18 +00:00
|
|
|
|
2020-08-19 16:28:04 +00:00
|
|
|
$(d)/conf-file.json: $(bindir)/nix
|
|
|
|
$(trace-gen) env -i NIX_CONF_DIR=/dummy HOME=/dummy $(bindir)/nix show-config --json --experimental-features nix-command > $@
|
|
|
|
|
2020-08-24 12:49:30 +00:00
|
|
|
$(d)/src/expressions/builtins.md: $(d)/builtins.json $(d)/generate-builtins.jq $(d)/src/expressions/builtins-prefix.md
|
|
|
|
cat doc/manual/src/expressions/builtins-prefix.md > $@
|
|
|
|
jq -r -f doc/manual/generate-builtins.jq $< >> $@
|
|
|
|
|
|
|
|
$(d)/builtins.json: $(bindir)/nix
|
|
|
|
$(trace-gen) $(bindir)/nix __dump-builtins > $@
|
|
|
|
|
2020-07-22 18:27:23 +00:00
|
|
|
# Generate the HTML manual.
|
|
|
|
install: $(docdir)/manual/index.html
|
2014-02-01 10:30:21 +00:00
|
|
|
|
2020-08-24 12:49:30 +00:00
|
|
|
$(docdir)/manual/index.html: $(MANUAL_SRCS) $(d)/book.toml $(d)/custom.css $(d)/src/command-ref/nix.md $(d)/src/command-ref/conf-file.md $(d)/src/expressions/builtins.md
|
2020-07-22 18:27:23 +00:00
|
|
|
$(trace-gen) mdbook build doc/manual -d $(docdir)/manual
|
2020-07-31 13:43:25 +00:00
|
|
|
@cp doc/manual/highlight.pack.js $(docdir)/manual/highlight.js
|
2016-09-20 14:31:23 +00:00
|
|
|
|
|
|
|
endif
|