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