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