1# -*- makefile -*- 2# Makefile for Sphinx documentation 3# 4 5# for cleaning 6subdir- := devicetree/bindings 7 8# Check for broken documentation file references 9ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y) 10$(shell $(srctree)/scripts/documentation-file-ref-check --warn) 11endif 12 13# Check for broken ABI files 14ifeq ($(CONFIG_WARN_ABI_ERRORS),y) 15$(shell $(srctree)/scripts/get_abi.pl validate --dir $(srctree)/Documentation/ABI) 16endif 17 18# You can set these variables from the command line. 19SPHINXBUILD = sphinx-build 20SPHINXOPTS = 21SPHINXDIRS = . 22_SPHINXDIRS = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst))) 23SPHINX_CONF = conf.py 24PAPER = 25BUILDDIR = $(obj)/output 26PDFLATEX = xelatex 27LATEXOPTS = -interaction=batchmode 28 29# User-friendly check for sphinx-build 30HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi) 31 32ifeq ($(HAVE_SPHINX),0) 33 34.DEFAULT: 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.) 36 @echo 37 @$(srctree)/scripts/sphinx-pre-install 38 @echo " SKIP Sphinx $@ target." 39 40else # HAVE_SPHINX 41 42# User-friendly check for pdflatex and latexmk 43HAVE_PDFLATEX := $(shell if which $(PDFLATEX) >/dev/null 2>&1; then echo 1; else echo 0; fi) 44HAVE_LATEXMK := $(shell if which latexmk >/dev/null 2>&1; then echo 1; else echo 0; fi) 45 46ifeq ($(HAVE_LATEXMK),1) 47 PDFLATEX := latexmk -$(PDFLATEX) 48endif #HAVE_LATEXMK 49 50# Internal variables. 51PAPEROPT_a4 = -D latex_paper_size=a4 52PAPEROPT_letter = -D latex_paper_size=letter 53KERNELDOC = $(srctree)/scripts/kernel-doc 54KERNELDOC_CONF = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC) 55ALLSPHINXOPTS = $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) 56# the i18n builder cannot share the environment and doctrees with the others 57I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 58 59# commands; the 'cmd' from scripts/Kbuild.include is not *loopable* 60loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit; 61 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 69 70quiet_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 \ 76 $(SPHINXBUILD) \ 77 -b $2 \ 78 -c $(abspath $(srctree)/$(src)) \ 79 -d $(abspath $(BUILDDIR)/.doctrees/$3) \ 80 -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \ 81 $(ALLSPHINXOPTS) \ 82 $(abspath $(srctree)/$(src)/$5) \ 83 $(abspath $(BUILDDIR)/$3/$4) 84 85htmldocs: 86 @$(srctree)/scripts/sphinx-pre-install --version-check 87 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var))) 88 89linkcheckdocs: 90 @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var))) 91 92latexdocs: 93 @$(srctree)/scripts/sphinx-pre-install --version-check 94 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var))) 95 96ifeq ($(HAVE_PDFLATEX),0) 97 98pdfdocs: 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." 101 102else # HAVE_PDFLATEX 103 104pdfdocs: latexdocs 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/; \ 110 ) 111 112endif # HAVE_PDFLATEX 113 114epubdocs: 115 @$(srctree)/scripts/sphinx-pre-install --version-check 116 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var))) 117 118xmldocs: 119 @$(srctree)/scripts/sphinx-pre-install --version-check 120 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var))) 121 122endif # HAVE_SPHINX 123 124# The following targets are independent of HAVE_SPHINX, and the rules should 125# work or silently pass without Sphinx. 126 127refcheckdocs: 128 $(Q)cd $(srctree);scripts/documentation-file-ref-check 129 130cleandocs: 131 $(Q)rm -rf $(BUILDDIR) 132 $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean 133 134dochelp: 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' 146 @echo 147 @echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2' 148 @echo ' valid values for SPHINXDIRS are: $(_SPHINXDIRS)' 149 @echo 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.' 152 @echo 153 @echo ' Default location for the generated documents is Documentation/output' 154