2 # Makefile for Sphinx documentation
6 subdir- := devicetree/bindings
8 # Check for broken documentation file references
9 ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y)
10 $(shell $(srctree)/scripts/documentation-file-ref-check --warn)
13 # Check for broken ABI files
14 ifeq ($(CONFIG_WARN_ABI_ERRORS),y)
15 $(shell $(srctree)/scripts/get_abi.pl validate --dir $(srctree)/Documentation/ABI)
18 # You can set these variables from the command line.
19 SPHINXBUILD = sphinx-build
22 _SPHINXDIRS = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst)))
25 BUILDDIR = $(obj)/output
27 LATEXOPTS = -interaction=batchmode
29 # User-friendly check for sphinx-build
30 HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi)
32 ifeq ($(HAVE_SPHINX),0)
35 $(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.)
37 @$(srctree)/scripts/sphinx-pre-install
38 @echo " SKIP Sphinx $@ target."
42 # User-friendly check for pdflatex and latexmk
43 HAVE_PDFLATEX := $(shell if which $(PDFLATEX) >/dev/null 2>&1; then echo 1; else echo 0; fi)
44 HAVE_LATEXMK := $(shell if which latexmk >/dev/null 2>&1; then echo 1; else echo 0; fi)
46 ifeq ($(HAVE_LATEXMK),1)
47 PDFLATEX := latexmk -$(PDFLATEX)
51 PAPEROPT_a4 = -D latex_paper_size=a4
52 PAPEROPT_letter = -D latex_paper_size=letter
53 KERNELDOC = $(srctree)/scripts/kernel-doc
54 KERNELDOC_CONF = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)
55 ALLSPHINXOPTS = $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)
56 # the i18n builder cannot share the environment and doctrees with the others
57 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
59 # commands; the 'cmd' from scripts/Kbuild.include is not *loopable*
60 loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit;
62 # $2 sphinx builder e.g. "html"
63 # $3 name of the build subfolder / e.g. "userspace-api/media", used as:
64 # * dest folder relative to $(BUILDDIR) and
65 # * cache folder relative to $(BUILDDIR)/.doctrees
66 # $4 dest subfolder e.g. "man" for man pages at userspace-api/media/man
67 # $5 reST source folder relative to $(srctree)/$(src),
68 # e.g. "userspace-api/media" for the linux-tv book-set at ./Documentation/userspace-api/media
70 quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
71 cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2 && \
72 PYTHONDONTWRITEBYTECODE=1 \
73 BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \
74 $(PYTHON) $(srctree)/scripts/jobserver-exec \
75 $(SHELL) $(srctree)/Documentation/sphinx/parallel-wrapper.sh \
78 -c $(abspath $(srctree)/$(src)) \
79 -d $(abspath $(BUILDDIR)/.doctrees/$3) \
80 -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \
82 $(abspath $(srctree)/$(src)/$5) \
83 $(abspath $(BUILDDIR)/$3/$4)
86 @$(srctree)/scripts/sphinx-pre-install --version-check
87 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
90 @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var)))
93 @$(srctree)/scripts/sphinx-pre-install --version-check
94 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var)))
96 ifeq ($(HAVE_PDFLATEX),0)
99 $(warning The '$(PDFLATEX)' command was not found. Make sure you have it installed and in PATH to produce PDF output.)
100 @echo " SKIP Sphinx $@ target."
105 @$(srctree)/scripts/sphinx-pre-install --version-check
106 $(foreach var,$(SPHINXDIRS), \
107 $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit; \
108 mkdir -p $(BUILDDIR)/$(var)/pdf; \
109 mv $(subst .tex,.pdf,$(wildcard $(BUILDDIR)/$(var)/latex/*.tex)) $(BUILDDIR)/$(var)/pdf/; \
112 endif # HAVE_PDFLATEX
115 @$(srctree)/scripts/sphinx-pre-install --version-check
116 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var)))
119 @$(srctree)/scripts/sphinx-pre-install --version-check
120 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var)))
124 # The following targets are independent of HAVE_SPHINX, and the rules should
125 # work or silently pass without Sphinx.
128 $(Q)cd $(srctree);scripts/documentation-file-ref-check
131 $(Q)rm -rf $(BUILDDIR)
132 $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean
135 @echo ' Linux kernel internal documentation in different formats from ReST:'
136 @echo ' htmldocs - HTML'
137 @echo ' latexdocs - LaTeX'
138 @echo ' pdfdocs - PDF'
139 @echo ' epubdocs - EPUB'
140 @echo ' xmldocs - XML'
141 @echo ' linkcheckdocs - check for broken external links'
142 @echo ' (will connect to external hosts)'
143 @echo ' refcheckdocs - check for references to non-existing files under'
144 @echo ' Documentation'
145 @echo ' cleandocs - clean all generated files'
147 @echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'
148 @echo ' valid values for SPHINXDIRS are: $(_SPHINXDIRS)'
150 @echo ' make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build'
151 @echo ' configuration. This is e.g. useful to build with nit-picking config.'
153 @echo ' Default location for the generated documents is Documentation/output'