Commit | Line | Data |
---|---|---|
cb43fb57 MCC |
1 | # -*- makefile -*- |
2 | # Makefile for Sphinx documentation | |
3 | # | |
4 | ||
4f0e3a57 | 5 | subdir-y := devicetree/bindings/ |
cb43fb57 MCC |
6 | |
7 | # You can set these variables from the command line. | |
8 | SPHINXBUILD = sphinx-build | |
9 | SPHINXOPTS = | |
10 | SPHINXDIRS = . | |
11 | _SPHINXDIRS = $(patsubst $(srctree)/Documentation/%/conf.py,%,$(wildcard $(srctree)/Documentation/*/conf.py)) | |
12 | SPHINX_CONF = conf.py | |
13 | PAPER = | |
14 | BUILDDIR = $(obj)/output | |
15 | PDFLATEX = xelatex | |
16 | LATEXOPTS = -interaction=batchmode | |
17 | ||
18 | # User-friendly check for sphinx-build | |
19 | HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi) | |
20 | ||
21 | ifeq ($(HAVE_SPHINX),0) | |
22 | ||
23 | .DEFAULT: | |
24 | $(warning The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed and in PATH, or set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable.) | |
92a037f0 MCC |
25 | @echo |
26 | @./scripts/sphinx-pre-install | |
cb43fb57 MCC |
27 | @echo " SKIP Sphinx $@ target." |
28 | ||
29 | else # HAVE_SPHINX | |
30 | ||
28f7c994 | 31 | # User-friendly check for pdflatex and latexmk |
cb43fb57 | 32 | HAVE_PDFLATEX := $(shell if which $(PDFLATEX) >/dev/null 2>&1; then echo 1; else echo 0; fi) |
28f7c994 MCC |
33 | HAVE_LATEXMK := $(shell if which latexmk >/dev/null 2>&1; then echo 1; else echo 0; fi) |
34 | ||
35 | ifeq ($(HAVE_LATEXMK),1) | |
36 | PDFLATEX := latexmk -$(PDFLATEX) | |
37 | endif #HAVE_LATEXMK | |
cb43fb57 MCC |
38 | |
39 | # Internal variables. | |
40 | PAPEROPT_a4 = -D latex_paper_size=a4 | |
41 | PAPEROPT_letter = -D latex_paper_size=letter | |
42 | KERNELDOC = $(srctree)/scripts/kernel-doc | |
43 | KERNELDOC_CONF = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC) | |
44 | ALLSPHINXOPTS = $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) | |
45 | # the i18n builder cannot share the environment and doctrees with the others | |
46 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | |
47 | ||
48 | # commands; the 'cmd' from scripts/Kbuild.include is not *loopable* | |
49 | loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit; | |
50 | ||
51 | # $2 sphinx builder e.g. "html" | |
52 | # $3 name of the build subfolder / e.g. "media", used as: | |
53 | # * dest folder relative to $(BUILDDIR) and | |
54 | # * cache folder relative to $(BUILDDIR)/.doctrees | |
55 | # $4 dest subfolder e.g. "man" for man pages at media/man | |
56 | # $5 reST source folder relative to $(srctree)/$(src), | |
57 | # e.g. "media" for the linux-tv book-set at ./Documentation/media | |
58 | ||
59 | quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4) | |
60 | cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media $2 && \ | |
61 | PYTHONDONTWRITEBYTECODE=1 \ | |
62 | BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \ | |
63 | $(SPHINXBUILD) \ | |
64 | -b $2 \ | |
65 | -c $(abspath $(srctree)/$(src)) \ | |
66 | -d $(abspath $(BUILDDIR)/.doctrees/$3) \ | |
67 | -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \ | |
68 | $(ALLSPHINXOPTS) \ | |
69 | $(abspath $(srctree)/$(src)/$5) \ | |
70 | $(abspath $(BUILDDIR)/$3/$4) | |
71 | ||
72 | htmldocs: | |
73 | @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var))) | |
74 | ||
75 | linkcheckdocs: | |
76 | @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var))) | |
77 | ||
78 | latexdocs: | |
79 | @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var))) | |
80 | ||
81 | ifeq ($(HAVE_PDFLATEX),0) | |
82 | ||
83 | pdfdocs: | |
84 | $(warning The '$(PDFLATEX)' command was not found. Make sure you have it installed and in PATH to produce PDF output.) | |
85 | @echo " SKIP Sphinx $@ target." | |
86 | ||
87 | else # HAVE_PDFLATEX | |
88 | ||
89 | pdfdocs: latexdocs | |
28f7c994 | 90 | $(foreach var,$(SPHINXDIRS), $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit;) |
cb43fb57 MCC |
91 | |
92 | endif # HAVE_PDFLATEX | |
93 | ||
94 | epubdocs: | |
95 | @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var))) | |
96 | ||
97 | xmldocs: | |
98 | @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var))) | |
99 | ||
100 | endif # HAVE_SPHINX | |
101 | ||
102 | # The following targets are independent of HAVE_SPHINX, and the rules should | |
103 | # work or silently pass without Sphinx. | |
104 | ||
e8939222 JN |
105 | refcheckdocs: |
106 | $(Q)cd $(srctree);scripts/documentation-file-ref-check | |
107 | ||
cb43fb57 MCC |
108 | cleandocs: |
109 | $(Q)rm -rf $(BUILDDIR) | |
110 | $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media clean | |
111 | ||
112 | dochelp: | |
113 | @echo ' Linux kernel internal documentation in different formats from ReST:' | |
114 | @echo ' htmldocs - HTML' | |
115 | @echo ' latexdocs - LaTeX' | |
116 | @echo ' pdfdocs - PDF' | |
117 | @echo ' epubdocs - EPUB' | |
118 | @echo ' xmldocs - XML' | |
119 | @echo ' linkcheckdocs - check for broken external links (will connect to external hosts)' | |
e8939222 | 120 | @echo ' refcheckdocs - check for references to non-existing files under Documentation' |
cb43fb57 MCC |
121 | @echo ' cleandocs - clean all generated files' |
122 | @echo | |
123 | @echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2' | |
124 | @echo ' valid values for SPHINXDIRS are: $(_SPHINXDIRS)' | |
125 | @echo | |
126 | @echo ' make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build' | |
127 | @echo ' configuration. This is e.g. useful to build with nit-picking config.' | |
9effc8f7 SK |
128 | @echo |
129 | @echo ' Default location for the generated documents is Documentation/output' |