Debian Codegraph @

doc/Makefile

raw
1 # Force rebuilds
2 .PHONY: progspell docs progdocs userdocs
3
4 doc-srcdir := $(realpath $(srcdir)/doc)
5 toolsdir := $(realpath $(srcdir)/tools)
6
7 docs: progdocs userdocs
8
9 doc-fmt = $(1): $(o)prog.$(1) $(o)bird.$(1)
10 $(call doc-fmt,html)
11 $(call doc-fmt,dvi)
12 $(call doc-fmt,ps)
13 $(call doc-fmt,pdf)
14
15 progdocs: $(o)prog.html $(o)prog.pdf
16 userdocs: $(o)bird.html $(o)bird.pdf
17 progspell: $(o)prog.spell
18
19 $(o)prog.sgml: $(srcdir)/tools/progdoc $(objdir)/.dir-stamp
20 $(srcdir)/tools/progdoc $(srcdir) $@
21
22 $(o)%.sgml: $(s)%.sgml $(objdir)/.dir-stamp
23 sed 's#{{ VERSION }}#$(VERSION)#' <$< >$@
24
25 $(o)%.html: $(o)%.sgml
26 cd $(dir $@) && $(toolsdir)/linuxdoc -B html $(notdir $<)
27
28 ifeq ($(PANDOC),)
29 $(o)%.md: $(o)%.sgml
30 @echo "ERROR: No pandoc available, install pandoc to build documentation"
31 @false
32 else
33 LINUXDOC_PANDOC_PARSER := $(srcdir)/tools/linuxdoc.lua
34 SINGLEPAGE_HTML_TEMPLATE := $(srcdir)/tools/doc-template.html
35 $(o)%.md: $(o)%.sgml $(LINUXDOC_PANDOC_PARSER) $(objdir)/.dir-stamp
36 $(PANDOC) -f $(LINUXDOC_PANDOC_PARSER) -s -t markdown -o $@ $<
37
38 $(o)%-singlepage.html: $(o)%.sgml $(SINGLEPAGE_HTML_TEMPLATE) $(LINUXDOC_PANDOC_PARSER) $(objdir)/.dir-stamp
39 $(PANDOC) -f $(LINUXDOC_PANDOC_PARSER) -t html5 --shift-heading-level-by=1 --section-divs --table-of-contents --toc-depth=3 -M bird_version="$(VERSION)" --template=$(SINGLEPAGE_HTML_TEMPLATE) -o $@ $<
40
41 endif
42
43 $(o)%.tex: $(o)%.sgml
44 cd $(dir $@) && $(toolsdir)/linuxdoc -B latex --output=tex $(notdir $<)
45
46 $(o)%.dvi: $(o)%.tex
47 cd $(dir $@) && TEXINPUTS=$(TEXINPUTS):$(doc-srcdir)/tex latex $(notdir $<)
48 cd $(dir $@) && TEXINPUTS=$(TEXINPUTS):$(doc-srcdir)/tex latex $(notdir $<)
49
50 $(o)%.ps: $(o)%.dvi
51 dvips -D600 -ta4 -o $@ $<
52
53 $(o)%.pdf: $(o)%.tex
54 TEXINPUTS=$(TEXINPUTS):$(doc-srcdir)/tex pdflatex -output-directory=$(dir $@) $<
55 TEXINPUTS=$(TEXINPUTS):$(doc-srcdir)/tex pdflatex -output-directory=$(dir $@) $<
56
57 $(o)%.txt: $(o)%.sgml
58 cd $(dir $@) && $(toolsdir)/linuxdoc -B txt $(notdir $<)
59
60 $(o)prog.spell: $(o)prog.sgml $(s)prog-spell.sed
61 sed -f $(lastword $^) <$< >$@
62 ispell $@
63
64 $(call clean,prog.spell $(addprefix *.,html dvi ps pdf sgml tex txt aux log toc))