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