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