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