tjh.dev
nixpkgs mirror (for testing)
github.com/NixOS/nixpkgs
nix
1MD_TARGETS=$(addsuffix .xml, $(basename $(shell find . -type f -regex '.*\.md$$' -not -name README.md)))
2
3PANDOC ?= pandoc
4
5pandoc_media_dir = media
6# NOTE: Keep in sync with conversion script (/maintainers/scripts/db-to-md.sh).
7# TODO: Remove raw-attribute when we can get rid of DocBook altogether.
8pandoc_commonmark_enabled_extensions = +attributes+fenced_divs+footnotes+bracketed_spans+definition_lists+pipe_tables+raw_attribute
9# Not needed:
10# - docbook-reader/citerefentry-to-rst-role.lua (only relevant for DocBook → MarkDown/rST/MyST)
11pandoc_flags = --extract-media=$(pandoc_media_dir) \
12 --lua-filter=$(PANDOC_LUA_FILTERS_DIR)/diagram-generator.lua \
13 --lua-filter=build-aux/pandoc-filters/myst-reader/roles.lua \
14 --lua-filter=$(PANDOC_LINK_MANPAGES_FILTER) \
15 --lua-filter=build-aux/pandoc-filters/docbook-writer/rst-roles.lua \
16 --lua-filter=build-aux/pandoc-filters/docbook-writer/labelless-link-is-xref.lua \
17 -f commonmark$(pandoc_commonmark_enabled_extensions)+smart
18
19.PHONY: all
20all: validate format out/html/index.html out/epub/manual.epub
21
22.PHONY: render-md
23render-md: ${MD_TARGETS}
24
25.PHONY: debug
26debug:
27 nix-shell --run "xmloscopy --docbook5 ./manual.xml ./manual-full.xml"
28
29.PHONY: format
30format: doc-support/result
31 find . -iname '*.xml' -type f | while read f; do \
32 echo $$f ;\
33 xmlformat --config-file "doc-support/result/xmlformat.conf" -i $$f ;\
34 done
35
36.PHONY: fix-misc-xml
37fix-misc-xml:
38 find . -iname '*.xml' -type f \
39 -exec ../nixos/doc/varlistentry-fixer.rb {} ';'
40
41.PHONY: clean
42clean:
43 rm -f ${MD_TARGETS} doc-support/result .version manual-full.xml functions/library/locations.xml functions/library/generated
44 rm -rf ./out/ ./highlightjs ./media
45
46.PHONY: validate
47validate: manual-full.xml doc-support/result
48 jing doc-support/result/docbook.rng manual-full.xml
49
50out/html/index.html: doc-support/result manual-full.xml style.css highlightjs
51 mkdir -p out/html
52 xsltproc \
53 --nonet --xinclude \
54 --output $@ \
55 doc-support/result/xhtml.xsl \
56 ./manual-full.xml
57
58 mkdir -p out/html/highlightjs/
59 cp -r highlightjs out/html/
60
61 cp -r $(pandoc_media_dir) out/html/
62 cp ./overrides.css out/html/
63 cp ./style.css out/html/style.css
64
65 mkdir -p out/html/images/callouts
66 cp doc-support/result/xsl/docbook/images/callouts/*.svg out/html/images/callouts/
67 chmod u+w -R out/html/
68
69out/epub/manual.epub: epub.xml
70 mkdir -p out/epub/scratch
71 xsltproc --nonet \
72 --output out/epub/scratch/ \
73 doc-support/result/epub.xsl \
74 ./epub.xml
75
76 echo "application/epub+zip" > mimetype
77 zip -0Xq "out/epub/manual.epub" mimetype
78 rm mimetype
79 cd "out/epub/scratch/" && zip -Xr9D "../manual.epub" *
80 rm -rf "out/epub/scratch/"
81
82highlightjs: doc-support/result
83 mkdir -p highlightjs
84 cp -r doc-support/result/highlightjs/highlight.pack.js highlightjs/
85 cp -r doc-support/result/highlightjs/LICENSE highlightjs/
86 cp -r doc-support/result/highlightjs/mono-blue.css highlightjs/
87 cp -r doc-support/result/highlightjs/loader.js highlightjs/
88
89
90manual-full.xml: ${MD_TARGETS} .version functions/library/locations.xml functions/library/generated *.xml **/*.xml **/**/*.xml
91 xmllint --nonet --xinclude --noxincludenode manual.xml --output manual-full.xml
92
93.version: doc-support/result
94 ln -rfs ./doc-support/result/version .version
95
96doc-support/result: doc-support/default.nix
97 (cd doc-support; nix-build)
98
99functions/library/locations.xml: doc-support/result
100 ln -rfs ./doc-support/result/function-locations.xml functions/library/locations.xml
101
102functions/library/generated: doc-support/result
103 ln -rfs ./doc-support/result/function-docs functions/library/generated
104
105%.section.xml: %.section.md
106 $(PANDOC) $^ -t docbook \
107 $(pandoc_flags) \
108 -o $@
109
110%.chapter.xml: %.chapter.md
111 $(PANDOC) $^ -t docbook \
112 --top-level-division=chapter \
113 $(pandoc_flags) \
114 -o $@