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