1cb43fb57SMauro Carvalho Chehab# -*- makefile -*- 2cb43fb57SMauro Carvalho Chehab# Makefile for Sphinx documentation 3cb43fb57SMauro Carvalho Chehab# 4cb43fb57SMauro Carvalho Chehab 5a1af8d71SMasahiro Yamada# for cleaning 6a1af8d71SMasahiro Yamadasubdir- := devicetree/bindings 7cb43fb57SMauro Carvalho Chehab 8b1663d7eSMauro Carvalho Chehab# Check for broken documentation file references 9b1663d7eSMauro Carvalho Chehabifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y) 10b1663d7eSMauro Carvalho Chehab$(shell $(srctree)/scripts/documentation-file-ref-check --warn) 11b1663d7eSMauro Carvalho Chehabendif 12b1663d7eSMauro Carvalho Chehab 1375442fb0SMauro Carvalho Chehab# Check for broken ABI files 1475442fb0SMauro Carvalho Chehabifeq ($(CONFIG_WARN_ABI_ERRORS),y) 1575442fb0SMauro Carvalho Chehab$(shell $(srctree)/scripts/get_abi.pl validate --dir $(srctree)/Documentation/ABI) 1675442fb0SMauro Carvalho Chehabendif 1775442fb0SMauro Carvalho Chehab 18cb43fb57SMauro Carvalho Chehab# You can set these variables from the command line. 19cb43fb57SMauro Carvalho ChehabSPHINXBUILD = sphinx-build 20cb43fb57SMauro Carvalho ChehabSPHINXOPTS = 21cb43fb57SMauro Carvalho ChehabSPHINXDIRS = . 22fca7216bSMauro Carvalho ChehabDOCS_THEME = 23135707d3SMauro Carvalho ChehabDOCS_CSS = 24965fc39fSRandy Dunlap_SPHINXDIRS = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst))) 25cb43fb57SMauro Carvalho ChehabSPHINX_CONF = conf.py 26cb43fb57SMauro Carvalho ChehabPAPER = 27cb43fb57SMauro Carvalho ChehabBUILDDIR = $(obj)/output 28cb43fb57SMauro Carvalho ChehabPDFLATEX = xelatex 296b22ce00SAkira YokosawaLATEXOPTS = -interaction=batchmode -no-shell-escape 30cb43fb57SMauro Carvalho Chehab 31c0d3b831SMasahiro Yamadaifeq ($(findstring 1, $(KBUILD_VERBOSE)),) 32d94df02cSMauro Carvalho ChehabSPHINXOPTS += "-q" 33d94df02cSMauro Carvalho Chehabendif 34d94df02cSMauro Carvalho Chehab 35cb43fb57SMauro Carvalho Chehab# User-friendly check for sphinx-build 36cb43fb57SMauro Carvalho ChehabHAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi) 37cb43fb57SMauro Carvalho Chehab 38cb43fb57SMauro Carvalho Chehabifeq ($(HAVE_SPHINX),0) 39cb43fb57SMauro Carvalho Chehab 40cb43fb57SMauro Carvalho Chehab.DEFAULT: 41cb43fb57SMauro Carvalho Chehab $(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.) 4292a037f0SMauro Carvalho Chehab @echo 436c01edd3SJonathan Corbet @$(srctree)/scripts/sphinx-pre-install 44cb43fb57SMauro Carvalho Chehab @echo " SKIP Sphinx $@ target." 45cb43fb57SMauro Carvalho Chehab 46cb43fb57SMauro Carvalho Chehabelse # HAVE_SPHINX 47cb43fb57SMauro Carvalho Chehab 4828f7c994SMauro Carvalho Chehab# User-friendly check for pdflatex and latexmk 49cb43fb57SMauro Carvalho ChehabHAVE_PDFLATEX := $(shell if which $(PDFLATEX) >/dev/null 2>&1; then echo 1; else echo 0; fi) 5028f7c994SMauro Carvalho ChehabHAVE_LATEXMK := $(shell if which latexmk >/dev/null 2>&1; then echo 1; else echo 0; fi) 5128f7c994SMauro Carvalho Chehab 5228f7c994SMauro Carvalho Chehabifeq ($(HAVE_LATEXMK),1) 5328f7c994SMauro Carvalho Chehab PDFLATEX := latexmk -$(PDFLATEX) 5428f7c994SMauro Carvalho Chehabendif #HAVE_LATEXMK 55cb43fb57SMauro Carvalho Chehab 56cb43fb57SMauro Carvalho Chehab# Internal variables. 57cb43fb57SMauro Carvalho ChehabPAPEROPT_a4 = -D latex_paper_size=a4 58cb43fb57SMauro Carvalho ChehabPAPEROPT_letter = -D latex_paper_size=letter 59cb43fb57SMauro Carvalho ChehabKERNELDOC = $(srctree)/scripts/kernel-doc 60cb43fb57SMauro Carvalho ChehabKERNELDOC_CONF = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC) 61cb43fb57SMauro Carvalho ChehabALLSPHINXOPTS = $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) 62c3521105SCarlos Bilbaoifneq ($(wildcard $(srctree)/.config),) 63c3521105SCarlos Bilbaoifeq ($(CONFIG_RUST),y) 64c3521105SCarlos Bilbao # Let Sphinx know we will include rustdoc 65c3521105SCarlos Bilbao ALLSPHINXOPTS += -t rustdoc 66c3521105SCarlos Bilbaoendif 67c3521105SCarlos Bilbaoendif 68cb43fb57SMauro Carvalho Chehab# the i18n builder cannot share the environment and doctrees with the others 69cb43fb57SMauro Carvalho ChehabI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 70cb43fb57SMauro Carvalho Chehab 71cb43fb57SMauro Carvalho Chehab# commands; the 'cmd' from scripts/Kbuild.include is not *loopable* 72cb43fb57SMauro Carvalho Chehabloop_cmd = $(echo-cmd) $(cmd_$(1)) || exit; 73cb43fb57SMauro Carvalho Chehab 74cb43fb57SMauro Carvalho Chehab# $2 sphinx builder e.g. "html" 7554f38fcaSMauro Carvalho Chehab# $3 name of the build subfolder / e.g. "userspace-api/media", used as: 76cb43fb57SMauro Carvalho Chehab# * dest folder relative to $(BUILDDIR) and 77cb43fb57SMauro Carvalho Chehab# * cache folder relative to $(BUILDDIR)/.doctrees 7854f38fcaSMauro Carvalho Chehab# $4 dest subfolder e.g. "man" for man pages at userspace-api/media/man 79cb43fb57SMauro Carvalho Chehab# $5 reST source folder relative to $(srctree)/$(src), 8054f38fcaSMauro Carvalho Chehab# e.g. "userspace-api/media" for the linux-tv book-set at ./Documentation/userspace-api/media 81cb43fb57SMauro Carvalho Chehab 82cb43fb57SMauro Carvalho Chehabquiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4) 8354f38fcaSMauro Carvalho Chehab cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2 && \ 84cb43fb57SMauro Carvalho Chehab PYTHONDONTWRITEBYTECODE=1 \ 85cb43fb57SMauro Carvalho Chehab BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \ 86d8d2d382SMasahiro Yamada $(PYTHON3) $(srctree)/scripts/jobserver-exec \ 87222a28edSKees Cook $(CONFIG_SHELL) $(srctree)/Documentation/sphinx/parallel-wrapper.sh \ 88cb43fb57SMauro Carvalho Chehab $(SPHINXBUILD) \ 89cb43fb57SMauro Carvalho Chehab -b $2 \ 90cb43fb57SMauro Carvalho Chehab -c $(abspath $(srctree)/$(src)) \ 91cb43fb57SMauro Carvalho Chehab -d $(abspath $(BUILDDIR)/.doctrees/$3) \ 92cb43fb57SMauro Carvalho Chehab -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \ 93cb43fb57SMauro Carvalho Chehab $(ALLSPHINXOPTS) \ 94cb43fb57SMauro Carvalho Chehab $(abspath $(srctree)/$(src)/$5) \ 95135707d3SMauro Carvalho Chehab $(abspath $(BUILDDIR)/$3/$4) && \ 96135707d3SMauro Carvalho Chehab if [ "x$(DOCS_CSS)" != "x" ]; then \ 9798d614bdSMauro Carvalho Chehab cp $(if $(patsubst /%,,$(DOCS_CSS)),$(abspath $(srctree)/$(DOCS_CSS)),$(DOCS_CSS)) $(BUILDDIR)/$3/_static/; \ 98135707d3SMauro Carvalho Chehab fi 99cb43fb57SMauro Carvalho Chehab 100f061c9f7SBreno LeitaoYNL_INDEX:=$(srctree)/Documentation/networking/netlink_spec/index.rst 101f061c9f7SBreno LeitaoYNL_RST_DIR:=$(srctree)/Documentation/networking/netlink_spec 102f061c9f7SBreno LeitaoYNL_YAML_DIR:=$(srctree)/Documentation/netlink/specs 103f061c9f7SBreno LeitaoYNL_TOOL:=$(srctree)/tools/net/ynl/ynl-gen-rst.py 104f061c9f7SBreno Leitao 105f061c9f7SBreno LeitaoYNL_RST_FILES_TMP := $(patsubst %.yaml,%.rst,$(wildcard $(YNL_YAML_DIR)/*.yaml)) 106f061c9f7SBreno LeitaoYNL_RST_FILES := $(patsubst $(YNL_YAML_DIR)%,$(YNL_RST_DIR)%, $(YNL_RST_FILES_TMP)) 107f061c9f7SBreno Leitao 108f061c9f7SBreno Leitao$(YNL_INDEX): $(YNL_RST_FILES) 109646158f2SDonald Hunter $(Q)$(YNL_TOOL) -o $@ -x 110f061c9f7SBreno Leitao 111646158f2SDonald Hunter$(YNL_RST_DIR)/%.rst: $(YNL_YAML_DIR)/%.yaml $(YNL_TOOL) 112646158f2SDonald Hunter $(Q)$(YNL_TOOL) -i $< -o $@ 113f061c9f7SBreno Leitao 114*a304fa1dSAkira Yokosawahtmldocs texinfodocs latexdocs epubdocs xmldocs: $(YNL_INDEX) 115*a304fa1dSAkira Yokosawa 116*a304fa1dSAkira Yokosawahtmldocs: 11718e15724SJonathan Corbet @$(srctree)/scripts/sphinx-pre-install --version-check 118cb43fb57SMauro Carvalho Chehab @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var))) 119cb43fb57SMauro Carvalho Chehab 120c3521105SCarlos Bilbao# If Rust support is available and .config exists, add rustdoc generated contents. 121c3521105SCarlos Bilbao# If there are any, the errors from this make rustdoc will be displayed but 122c3521105SCarlos Bilbao# won't stop the execution of htmldocs 123c3521105SCarlos Bilbao 124c3521105SCarlos Bilbaoifneq ($(wildcard $(srctree)/.config),) 125c3521105SCarlos Bilbaoifeq ($(CONFIG_RUST),y) 126c3521105SCarlos Bilbao $(Q)$(MAKE) rustdoc || true 127c3521105SCarlos Bilbaoendif 128c3521105SCarlos Bilbaoendif 129c3521105SCarlos Bilbao 1301f050e90SMaxim Cournoyertexinfodocs: 1311f050e90SMaxim Cournoyer @$(srctree)/scripts/sphinx-pre-install --version-check 1321f050e90SMaxim Cournoyer @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,texinfo,$(var),texinfo,$(var))) 1331f050e90SMaxim Cournoyer 1341f050e90SMaxim Cournoyer# Note: the 'info' Make target is generated by sphinx itself when 1351f050e90SMaxim Cournoyer# running the texinfodocs target define above. 1361f050e90SMaxim Cournoyerinfodocs: texinfodocs 1371f050e90SMaxim Cournoyer $(MAKE) -C $(BUILDDIR)/texinfo info 1381f050e90SMaxim Cournoyer 139cb43fb57SMauro Carvalho Chehablinkcheckdocs: 140cb43fb57SMauro Carvalho Chehab @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var))) 141cb43fb57SMauro Carvalho Chehab 142cb43fb57SMauro Carvalho Chehablatexdocs: 14318e15724SJonathan Corbet @$(srctree)/scripts/sphinx-pre-install --version-check 144cb43fb57SMauro Carvalho Chehab @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var))) 145cb43fb57SMauro Carvalho Chehab 146cb43fb57SMauro Carvalho Chehabifeq ($(HAVE_PDFLATEX),0) 147cb43fb57SMauro Carvalho Chehab 148cb43fb57SMauro Carvalho Chehabpdfdocs: 149cb43fb57SMauro Carvalho Chehab $(warning The '$(PDFLATEX)' command was not found. Make sure you have it installed and in PATH to produce PDF output.) 150cb43fb57SMauro Carvalho Chehab @echo " SKIP Sphinx $@ target." 151cb43fb57SMauro Carvalho Chehab 152cb43fb57SMauro Carvalho Chehabelse # HAVE_PDFLATEX 153cb43fb57SMauro Carvalho Chehab 154cb43fb57SMauro Carvalho Chehabpdfdocs: latexdocs 15518e15724SJonathan Corbet @$(srctree)/scripts/sphinx-pre-install --version-check 156baeb2d5cSMauro Carvalho Chehab $(foreach var,$(SPHINXDIRS), \ 157baeb2d5cSMauro Carvalho Chehab $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit; \ 158baeb2d5cSMauro Carvalho Chehab mkdir -p $(BUILDDIR)/$(var)/pdf; \ 159baeb2d5cSMauro Carvalho Chehab mv $(subst .tex,.pdf,$(wildcard $(BUILDDIR)/$(var)/latex/*.tex)) $(BUILDDIR)/$(var)/pdf/; \ 160baeb2d5cSMauro Carvalho Chehab ) 161cb43fb57SMauro Carvalho Chehab 162cb43fb57SMauro Carvalho Chehabendif # HAVE_PDFLATEX 163cb43fb57SMauro Carvalho Chehab 164cb43fb57SMauro Carvalho Chehabepubdocs: 16518e15724SJonathan Corbet @$(srctree)/scripts/sphinx-pre-install --version-check 166cb43fb57SMauro Carvalho Chehab @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var))) 167cb43fb57SMauro Carvalho Chehab 168cb43fb57SMauro Carvalho Chehabxmldocs: 16918e15724SJonathan Corbet @$(srctree)/scripts/sphinx-pre-install --version-check 170cb43fb57SMauro Carvalho Chehab @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var))) 171cb43fb57SMauro Carvalho Chehab 172cb43fb57SMauro Carvalho Chehabendif # HAVE_SPHINX 173cb43fb57SMauro Carvalho Chehab 174cb43fb57SMauro Carvalho Chehab# The following targets are independent of HAVE_SPHINX, and the rules should 175cb43fb57SMauro Carvalho Chehab# work or silently pass without Sphinx. 176cb43fb57SMauro Carvalho Chehab 177e8939222SJani Nikularefcheckdocs: 178e8939222SJani Nikula $(Q)cd $(srctree);scripts/documentation-file-ref-check 179e8939222SJani Nikula 180cb43fb57SMauro Carvalho Chehabcleandocs: 1817da8bdbfSThorsten Blum $(Q)rm -f $(YNL_INDEX) $(YNL_RST_FILES) 182cb43fb57SMauro Carvalho Chehab $(Q)rm -rf $(BUILDDIR) 18354f38fcaSMauro Carvalho Chehab $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean 184cb43fb57SMauro Carvalho Chehab 185cb43fb57SMauro Carvalho Chehabdochelp: 186cb43fb57SMauro Carvalho Chehab @echo ' Linux kernel internal documentation in different formats from ReST:' 187cb43fb57SMauro Carvalho Chehab @echo ' htmldocs - HTML' 1881f050e90SMaxim Cournoyer @echo ' texinfodocs - Texinfo' 1891f050e90SMaxim Cournoyer @echo ' infodocs - Info' 190cb43fb57SMauro Carvalho Chehab @echo ' latexdocs - LaTeX' 191cb43fb57SMauro Carvalho Chehab @echo ' pdfdocs - PDF' 192cb43fb57SMauro Carvalho Chehab @echo ' epubdocs - EPUB' 193cb43fb57SMauro Carvalho Chehab @echo ' xmldocs - XML' 194a64c0440SGeert Uytterhoeven @echo ' linkcheckdocs - check for broken external links' 195a64c0440SGeert Uytterhoeven @echo ' (will connect to external hosts)' 196a64c0440SGeert Uytterhoeven @echo ' refcheckdocs - check for references to non-existing files under' 197a64c0440SGeert Uytterhoeven @echo ' Documentation' 198cb43fb57SMauro Carvalho Chehab @echo ' cleandocs - clean all generated files' 199cb43fb57SMauro Carvalho Chehab @echo 200cb43fb57SMauro Carvalho Chehab @echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2' 201cb43fb57SMauro Carvalho Chehab @echo ' valid values for SPHINXDIRS are: $(_SPHINXDIRS)' 202cb43fb57SMauro Carvalho Chehab @echo 203cb43fb57SMauro Carvalho Chehab @echo ' make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build' 204cb43fb57SMauro Carvalho Chehab @echo ' configuration. This is e.g. useful to build with nit-picking config.' 2059effc8f7SShuah Khan @echo 206fca7216bSMauro Carvalho Chehab @echo ' make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.' 207fca7216bSMauro Carvalho Chehab @echo 208135707d3SMauro Carvalho Chehab @echo ' make DOCS_CSS={a .css file} adds a DOCS_CSS override file for html/epub output.' 209135707d3SMauro Carvalho Chehab @echo 2109effc8f7SShuah Khan @echo ' Default location for the generated documents is Documentation/output' 211