blob: 023fa658a0a878f749be6ddc609c92246ebe6e92 [file] [log] [blame]
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -03001# -*- makefile -*-
2# Makefile for Sphinx documentation
3#
4
Masahiro Yamadaa1af8d72020-02-27 02:53:25 +09005# for cleaning
6subdir- := devicetree/bindings
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -03007
Mauro Carvalho Chehabb1663d72019-06-04 09:26:27 -03008# Check for broken documentation file references
9ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y)
10$(shell $(srctree)/scripts/documentation-file-ref-check --warn)
11endif
12
Mauro Carvalho Chehab75442fb2020-10-30 08:40:45 +010013# 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
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030018# You can set these variables from the command line.
19SPHINXBUILD = sphinx-build
20SPHINXOPTS =
21SPHINXDIRS = .
Mauro Carvalho Chehabfca72162021-12-07 10:52:59 +010022DOCS_THEME =
Mauro Carvalho Chehab135707d2021-12-07 10:53:00 +010023DOCS_CSS =
Randy Dunlap965fc392020-02-15 23:26:06 -080024_SPHINXDIRS = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst)))
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030025SPHINX_CONF = conf.py
26PAPER =
27BUILDDIR = $(obj)/output
28PDFLATEX = xelatex
Akira Yokosawa6b22ce02022-02-10 10:26:53 +090029LATEXOPTS = -interaction=batchmode -no-shell-escape
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030030
Masahiro Yamadac0d3b832022-12-23 01:25:33 +090031ifeq ($(findstring 1, $(KBUILD_VERBOSE)),)
Mauro Carvalho Chehabd94df022020-10-27 11:56:15 +010032SPHINXOPTS += "-q"
33endif
34
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030035# 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.)
Mauro Carvalho Chehab92a037f2017-07-16 19:08:06 -030042 @echo
Jonathan Corbet6c01edd2019-05-31 10:02:11 -060043 @$(srctree)/scripts/sphinx-pre-install
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030044 @echo " SKIP Sphinx $@ target."
45
46else # HAVE_SPHINX
47
Mauro Carvalho Chehab28f7c992019-03-30 10:45:58 -030048# User-friendly check for pdflatex and latexmk
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030049HAVE_PDFLATEX := $(shell if which $(PDFLATEX) >/dev/null 2>&1; then echo 1; else echo 0; fi)
Mauro Carvalho Chehab28f7c992019-03-30 10:45:58 -030050HAVE_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
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030055
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"
Mauro Carvalho Chehab54f38fc2020-03-04 10:21:39 +010069# $3 name of the build subfolder / e.g. "userspace-api/media", used as:
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030070# * dest folder relative to $(BUILDDIR) and
71# * cache folder relative to $(BUILDDIR)/.doctrees
Mauro Carvalho Chehab54f38fc2020-03-04 10:21:39 +010072# $4 dest subfolder e.g. "man" for man pages at userspace-api/media/man
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030073# $5 reST source folder relative to $(srctree)/$(src),
Mauro Carvalho Chehab54f38fc2020-03-04 10:21:39 +010074# e.g. "userspace-api/media" for the linux-tv book-set at ./Documentation/userspace-api/media
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030075
76quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
Mauro Carvalho Chehab54f38fc2020-03-04 10:21:39 +010077 cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2 && \
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030078 PYTHONDONTWRITEBYTECODE=1 \
79 BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \
Masahiro Yamadad8d2d382021-02-01 10:00:24 +090080 $(PYTHON3) $(srctree)/scripts/jobserver-exec \
Kees Cook222a28e2021-06-17 15:58:08 -070081 $(CONFIG_SHELL) $(srctree)/Documentation/sphinx/parallel-wrapper.sh \
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030082 $(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) \
Mauro Carvalho Chehab135707d2021-12-07 10:53:00 +010089 $(abspath $(BUILDDIR)/$3/$4) && \
90 if [ "x$(DOCS_CSS)" != "x" ]; then \
Mauro Carvalho Chehab98d614b2021-12-11 09:56:59 +010091 cp $(if $(patsubst /%,,$(DOCS_CSS)),$(abspath $(srctree)/$(DOCS_CSS)),$(DOCS_CSS)) $(BUILDDIR)/$3/_static/; \
Mauro Carvalho Chehab135707d2021-12-07 10:53:00 +010092 fi
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030093
94htmldocs:
Jonathan Corbet18e15722019-06-04 07:55:49 -060095 @$(srctree)/scripts/sphinx-pre-install --version-check
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -030096 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
97
Maxim Cournoyer1f050e92022-11-16 14:02:09 -050098texinfodocs:
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
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -0300107linkcheckdocs:
108 @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var)))
109
110latexdocs:
Jonathan Corbet18e15722019-06-04 07:55:49 -0600111 @$(srctree)/scripts/sphinx-pre-install --version-check
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -0300112 @+$(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
Jonathan Corbet18e15722019-06-04 07:55:49 -0600123 @$(srctree)/scripts/sphinx-pre-install --version-check
Mauro Carvalho Chehabbaeb2d52020-04-14 18:48:53 +0200124 $(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 )
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -0300129
130endif # HAVE_PDFLATEX
131
132epubdocs:
Jonathan Corbet18e15722019-06-04 07:55:49 -0600133 @$(srctree)/scripts/sphinx-pre-install --version-check
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -0300134 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var)))
135
136xmldocs:
Jonathan Corbet18e15722019-06-04 07:55:49 -0600137 @$(srctree)/scripts/sphinx-pre-install --version-check
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -0300138 @+$(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
Jani Nikulae8939222017-10-09 18:26:15 +0300145refcheckdocs:
146 $(Q)cd $(srctree);scripts/documentation-file-ref-check
147
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -0300148cleandocs:
149 $(Q)rm -rf $(BUILDDIR)
Mauro Carvalho Chehab54f38fc2020-03-04 10:21:39 +0100150 $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -0300151
152dochelp:
153 @echo ' Linux kernel internal documentation in different formats from ReST:'
154 @echo ' htmldocs - HTML'
Maxim Cournoyer1f050e92022-11-16 14:02:09 -0500155 @echo ' texinfodocs - Texinfo'
156 @echo ' infodocs - Info'
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -0300157 @echo ' latexdocs - LaTeX'
158 @echo ' pdfdocs - PDF'
159 @echo ' epubdocs - EPUB'
160 @echo ' xmldocs - XML'
Geert Uytterhoevena64c0442019-10-25 13:52:32 +0200161 @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'
Mauro Carvalho Chehabcb43fb52017-05-14 11:50:01 -0300165 @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.'
Shuah Khan9effc8f2017-10-02 17:44:18 -0600172 @echo
Mauro Carvalho Chehab0e805b12021-12-11 09:57:00 +0100173 @echo ' make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.'
Mauro Carvalho Chehabfca72162021-12-07 10:52:59 +0100174 @echo
Mauro Carvalho Chehab0e805b12021-12-11 09:57:00 +0100175 @echo ' make DOCS_CSS={a .css file} adds a DOCS_CSS override file for html/epub output.'
Mauro Carvalho Chehab135707d2021-12-07 10:53:00 +0100176 @echo
Shuah Khan9effc8f2017-10-02 17:44:18 -0600177 @echo ' Default location for the generated documents is Documentation/output'