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.py --dir $(srctree)/Documentation/ABI validate) 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 31# For denylisting "variable font" files 32# Can be overridden by setting as an env variable 33FONTS_CONF_DENY_VF ?= $(HOME)/deny-vf 34 35ifeq ($(findstring 1, $(KBUILD_VERBOSE)),) 36SPHINXOPTS += "-q" 37endif 38 39# User-friendly check for sphinx-build 40HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi) 41 42ifeq ($(HAVE_SPHINX),0) 43 44.DEFAULT: 45 $(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.) 46 @echo 47 @$(srctree)/scripts/sphinx-pre-install 48 @echo " SKIP Sphinx $@ target." 49 50else # HAVE_SPHINX 51 52# User-friendly check for pdflatex and latexmk 53HAVE_PDFLATEX := $(shell if which $(PDFLATEX) >/dev/null 2>&1; then echo 1; else echo 0; fi) 54HAVE_LATEXMK := $(shell if which latexmk >/dev/null 2>&1; then echo 1; else echo 0; fi) 55 56ifeq ($(HAVE_LATEXMK),1) 57 PDFLATEX := latexmk -$(PDFLATEX) 58endif #HAVE_LATEXMK 59 60# Internal variables. 61PAPEROPT_a4 = -D latex_paper_size=a4 62PAPEROPT_letter = -D latex_paper_size=letter 63ALLSPHINXOPTS = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC) 64ALLSPHINXOPTS += $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) 65ifneq ($(wildcard $(srctree)/.config),) 66ifeq ($(CONFIG_RUST),y) 67 # Let Sphinx know we will include rustdoc 68 ALLSPHINXOPTS += -t rustdoc 69endif 70endif 71# the i18n builder cannot share the environment and doctrees with the others 72I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 73 74# commands; the 'cmd' from scripts/Kbuild.include is not *loopable* 75loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit; 76 77# $2 sphinx builder e.g. "html" 78# $3 name of the build subfolder / e.g. "userspace-api/media", used as: 79# * dest folder relative to $(BUILDDIR) and 80# * cache folder relative to $(BUILDDIR)/.doctrees 81# $4 dest subfolder e.g. "man" for man pages at userspace-api/media/man 82# $5 reST source folder relative to $(src), 83# e.g. "userspace-api/media" for the linux-tv book-set at ./Documentation/userspace-api/media 84 85quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4) 86 cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2 && \ 87 PYTHONDONTWRITEBYTECODE=1 \ 88 BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(src)/$5/$(SPHINX_CONF)) \ 89 $(PYTHON3) $(srctree)/scripts/jobserver-exec \ 90 $(CONFIG_SHELL) $(srctree)/Documentation/sphinx/parallel-wrapper.sh \ 91 $(SPHINXBUILD) \ 92 -b $2 \ 93 -c $(abspath $(src)) \ 94 -d $(abspath $(BUILDDIR)/.doctrees/$3) \ 95 -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \ 96 $(ALLSPHINXOPTS) \ 97 $(abspath $(src)/$5) \ 98 $(abspath $(BUILDDIR)/$3/$4) && \ 99 if [ "x$(DOCS_CSS)" != "x" ]; then \ 100 cp $(if $(patsubst /%,,$(DOCS_CSS)),$(abspath $(srctree)/$(DOCS_CSS)),$(DOCS_CSS)) $(BUILDDIR)/$3/_static/; \ 101 fi 102 103YNL_INDEX:=$(srctree)/Documentation/networking/netlink_spec/index.rst 104YNL_RST_DIR:=$(srctree)/Documentation/networking/netlink_spec 105YNL_YAML_DIR:=$(srctree)/Documentation/netlink/specs 106YNL_TOOL:=$(srctree)/tools/net/ynl/pyynl/ynl_gen_rst.py 107 108YNL_RST_FILES_TMP := $(patsubst %.yaml,%.rst,$(wildcard $(YNL_YAML_DIR)/*.yaml)) 109YNL_RST_FILES := $(patsubst $(YNL_YAML_DIR)%,$(YNL_RST_DIR)%, $(YNL_RST_FILES_TMP)) 110 111$(YNL_INDEX): $(YNL_RST_FILES) 112 $(Q)$(YNL_TOOL) -o $@ -x 113 114$(YNL_RST_DIR)/%.rst: $(YNL_YAML_DIR)/%.yaml $(YNL_TOOL) 115 $(Q)$(YNL_TOOL) -i $< -o $@ 116 117htmldocs texinfodocs latexdocs epubdocs xmldocs: $(YNL_INDEX) 118 119htmldocs: 120 @$(srctree)/scripts/sphinx-pre-install --version-check 121 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var))) 122 123# If Rust support is available and .config exists, add rustdoc generated contents. 124# If there are any, the errors from this make rustdoc will be displayed but 125# won't stop the execution of htmldocs 126 127ifneq ($(wildcard $(srctree)/.config),) 128ifeq ($(CONFIG_RUST),y) 129 $(Q)$(MAKE) rustdoc || true 130endif 131endif 132 133texinfodocs: 134 @$(srctree)/scripts/sphinx-pre-install --version-check 135 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,texinfo,$(var),texinfo,$(var))) 136 137# Note: the 'info' Make target is generated by sphinx itself when 138# running the texinfodocs target define above. 139infodocs: texinfodocs 140 $(MAKE) -C $(BUILDDIR)/texinfo info 141 142linkcheckdocs: 143 @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var))) 144 145latexdocs: 146 @$(srctree)/scripts/sphinx-pre-install --version-check 147 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var))) 148 149ifeq ($(HAVE_PDFLATEX),0) 150 151pdfdocs: 152 $(warning The '$(PDFLATEX)' command was not found. Make sure you have it installed and in PATH to produce PDF output.) 153 @echo " SKIP Sphinx $@ target." 154 155else # HAVE_PDFLATEX 156 157pdfdocs: DENY_VF = XDG_CONFIG_HOME=$(FONTS_CONF_DENY_VF) 158pdfdocs: latexdocs 159 @$(srctree)/scripts/sphinx-pre-install --version-check 160 $(foreach var,$(SPHINXDIRS), \ 161 $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" $(DENY_VF) -C $(BUILDDIR)/$(var)/latex || sh $(srctree)/scripts/check-variable-fonts.sh || exit; \ 162 mkdir -p $(BUILDDIR)/$(var)/pdf; \ 163 mv $(subst .tex,.pdf,$(wildcard $(BUILDDIR)/$(var)/latex/*.tex)) $(BUILDDIR)/$(var)/pdf/; \ 164 ) 165 166endif # HAVE_PDFLATEX 167 168epubdocs: 169 @$(srctree)/scripts/sphinx-pre-install --version-check 170 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var))) 171 172xmldocs: 173 @$(srctree)/scripts/sphinx-pre-install --version-check 174 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var))) 175 176endif # HAVE_SPHINX 177 178# The following targets are independent of HAVE_SPHINX, and the rules should 179# work or silently pass without Sphinx. 180 181refcheckdocs: 182 $(Q)cd $(srctree);scripts/documentation-file-ref-check 183 184cleandocs: 185 $(Q)rm -f $(YNL_INDEX) $(YNL_RST_FILES) 186 $(Q)rm -rf $(BUILDDIR) 187 $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean 188 189dochelp: 190 @echo ' Linux kernel internal documentation in different formats from ReST:' 191 @echo ' htmldocs - HTML' 192 @echo ' texinfodocs - Texinfo' 193 @echo ' infodocs - Info' 194 @echo ' latexdocs - LaTeX' 195 @echo ' pdfdocs - PDF' 196 @echo ' epubdocs - EPUB' 197 @echo ' xmldocs - XML' 198 @echo ' linkcheckdocs - check for broken external links' 199 @echo ' (will connect to external hosts)' 200 @echo ' refcheckdocs - check for references to non-existing files under' 201 @echo ' Documentation' 202 @echo ' cleandocs - clean all generated files' 203 @echo 204 @echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2' 205 @echo ' valid values for SPHINXDIRS are: $(_SPHINXDIRS)' 206 @echo 207 @echo ' make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build' 208 @echo ' configuration. This is e.g. useful to build with nit-picking config.' 209 @echo 210 @echo ' make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.' 211 @echo 212 @echo ' make DOCS_CSS={a .css file} adds a DOCS_CSS override file for html/epub output.' 213 @echo 214 @echo ' Default location for the generated documents is Documentation/output' 215