1cb43fb57SMauro Carvalho Chehab# -*- makefile -*- 2cb43fb57SMauro Carvalho Chehab# Makefile for Sphinx documentation 3cb43fb57SMauro Carvalho Chehab# 4cb43fb57SMauro Carvalho Chehab 54f0e3a57SRob Herringsubdir-y := devicetree/bindings/ 6cb43fb57SMauro Carvalho Chehab 7cb43fb57SMauro Carvalho Chehab# You can set these variables from the command line. 8cb43fb57SMauro Carvalho ChehabSPHINXBUILD = sphinx-build 9cb43fb57SMauro Carvalho ChehabSPHINXOPTS = 10cb43fb57SMauro Carvalho ChehabSPHINXDIRS = . 11cb43fb57SMauro Carvalho Chehab_SPHINXDIRS = $(patsubst $(srctree)/Documentation/%/conf.py,%,$(wildcard $(srctree)/Documentation/*/conf.py)) 12cb43fb57SMauro Carvalho ChehabSPHINX_CONF = conf.py 13cb43fb57SMauro Carvalho ChehabPAPER = 14cb43fb57SMauro Carvalho ChehabBUILDDIR = $(obj)/output 15cb43fb57SMauro Carvalho ChehabPDFLATEX = xelatex 16cb43fb57SMauro Carvalho ChehabLATEXOPTS = -interaction=batchmode 17cb43fb57SMauro Carvalho Chehab 18cb43fb57SMauro Carvalho Chehab# User-friendly check for sphinx-build 19cb43fb57SMauro Carvalho ChehabHAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi) 20cb43fb57SMauro Carvalho Chehab 21cb43fb57SMauro Carvalho Chehabifeq ($(HAVE_SPHINX),0) 22cb43fb57SMauro Carvalho Chehab 23cb43fb57SMauro Carvalho Chehab.DEFAULT: 24cb43fb57SMauro 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.) 2592a037f0SMauro Carvalho Chehab @echo 26*6c01edd3SJonathan Corbet @$(srctree)/scripts/sphinx-pre-install 27cb43fb57SMauro Carvalho Chehab @echo " SKIP Sphinx $@ target." 28cb43fb57SMauro Carvalho Chehab 29cb43fb57SMauro Carvalho Chehabelse # HAVE_SPHINX 30cb43fb57SMauro Carvalho Chehab 31cf08508dSMauro Carvalho Chehabexport SPHINXOPTS = $(shell perl -e 'open IN,"sphinx-build --version 2>&1 |"; while (<IN>) { if (m/([\d\.]+)/) { print "-jauto" if ($$1 >= "1.7") } ;} close IN') 32cf08508dSMauro Carvalho Chehab 3328f7c994SMauro Carvalho Chehab# User-friendly check for pdflatex and latexmk 34cb43fb57SMauro Carvalho ChehabHAVE_PDFLATEX := $(shell if which $(PDFLATEX) >/dev/null 2>&1; then echo 1; else echo 0; fi) 3528f7c994SMauro Carvalho ChehabHAVE_LATEXMK := $(shell if which latexmk >/dev/null 2>&1; then echo 1; else echo 0; fi) 3628f7c994SMauro Carvalho Chehab 3728f7c994SMauro Carvalho Chehabifeq ($(HAVE_LATEXMK),1) 3828f7c994SMauro Carvalho Chehab PDFLATEX := latexmk -$(PDFLATEX) 3928f7c994SMauro Carvalho Chehabendif #HAVE_LATEXMK 40cb43fb57SMauro Carvalho Chehab 41cb43fb57SMauro Carvalho Chehab# Internal variables. 42cb43fb57SMauro Carvalho ChehabPAPEROPT_a4 = -D latex_paper_size=a4 43cb43fb57SMauro Carvalho ChehabPAPEROPT_letter = -D latex_paper_size=letter 44cb43fb57SMauro Carvalho ChehabKERNELDOC = $(srctree)/scripts/kernel-doc 45cb43fb57SMauro Carvalho ChehabKERNELDOC_CONF = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC) 46cb43fb57SMauro Carvalho ChehabALLSPHINXOPTS = $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) 47cb43fb57SMauro Carvalho Chehab# the i18n builder cannot share the environment and doctrees with the others 48cb43fb57SMauro Carvalho ChehabI18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 49cb43fb57SMauro Carvalho Chehab 50cb43fb57SMauro Carvalho Chehab# commands; the 'cmd' from scripts/Kbuild.include is not *loopable* 51cb43fb57SMauro Carvalho Chehabloop_cmd = $(echo-cmd) $(cmd_$(1)) || exit; 52cb43fb57SMauro Carvalho Chehab 53cb43fb57SMauro Carvalho Chehab# $2 sphinx builder e.g. "html" 54cb43fb57SMauro Carvalho Chehab# $3 name of the build subfolder / e.g. "media", used as: 55cb43fb57SMauro Carvalho Chehab# * dest folder relative to $(BUILDDIR) and 56cb43fb57SMauro Carvalho Chehab# * cache folder relative to $(BUILDDIR)/.doctrees 57cb43fb57SMauro Carvalho Chehab# $4 dest subfolder e.g. "man" for man pages at media/man 58cb43fb57SMauro Carvalho Chehab# $5 reST source folder relative to $(srctree)/$(src), 59cb43fb57SMauro Carvalho Chehab# e.g. "media" for the linux-tv book-set at ./Documentation/media 60cb43fb57SMauro Carvalho Chehab 61cb43fb57SMauro Carvalho Chehabquiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4) 62cb43fb57SMauro Carvalho Chehab cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media $2 && \ 63cb43fb57SMauro Carvalho Chehab PYTHONDONTWRITEBYTECODE=1 \ 64cb43fb57SMauro Carvalho Chehab BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \ 65cb43fb57SMauro Carvalho Chehab $(SPHINXBUILD) \ 66cb43fb57SMauro Carvalho Chehab -b $2 \ 67cb43fb57SMauro Carvalho Chehab -c $(abspath $(srctree)/$(src)) \ 68cb43fb57SMauro Carvalho Chehab -d $(abspath $(BUILDDIR)/.doctrees/$3) \ 69cb43fb57SMauro Carvalho Chehab -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \ 70cb43fb57SMauro Carvalho Chehab $(ALLSPHINXOPTS) \ 71cb43fb57SMauro Carvalho Chehab $(abspath $(srctree)/$(src)/$5) \ 72cb43fb57SMauro Carvalho Chehab $(abspath $(BUILDDIR)/$3/$4) 73cb43fb57SMauro Carvalho Chehab 74cb43fb57SMauro Carvalho Chehabhtmldocs: 759b88ad54SMauro Carvalho Chehab @./scripts/sphinx-pre-install --version-check 76cb43fb57SMauro Carvalho Chehab @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var))) 77cb43fb57SMauro Carvalho Chehab 78cb43fb57SMauro Carvalho Chehablinkcheckdocs: 79cb43fb57SMauro Carvalho Chehab @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var))) 80cb43fb57SMauro Carvalho Chehab 81cb43fb57SMauro Carvalho Chehablatexdocs: 829b88ad54SMauro Carvalho Chehab @./scripts/sphinx-pre-install --version-check 83cb43fb57SMauro Carvalho Chehab @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var))) 84cb43fb57SMauro Carvalho Chehab 85cb43fb57SMauro Carvalho Chehabifeq ($(HAVE_PDFLATEX),0) 86cb43fb57SMauro Carvalho Chehab 87cb43fb57SMauro Carvalho Chehabpdfdocs: 88cb43fb57SMauro Carvalho Chehab $(warning The '$(PDFLATEX)' command was not found. Make sure you have it installed and in PATH to produce PDF output.) 89cb43fb57SMauro Carvalho Chehab @echo " SKIP Sphinx $@ target." 90cb43fb57SMauro Carvalho Chehab 91cb43fb57SMauro Carvalho Chehabelse # HAVE_PDFLATEX 92cb43fb57SMauro Carvalho Chehab 93cb43fb57SMauro Carvalho Chehabpdfdocs: latexdocs 949b88ad54SMauro Carvalho Chehab @./scripts/sphinx-pre-install --version-check 9528f7c994SMauro Carvalho Chehab $(foreach var,$(SPHINXDIRS), $(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit;) 96cb43fb57SMauro Carvalho Chehab 97cb43fb57SMauro Carvalho Chehabendif # HAVE_PDFLATEX 98cb43fb57SMauro Carvalho Chehab 99cb43fb57SMauro Carvalho Chehabepubdocs: 1009b88ad54SMauro Carvalho Chehab @./scripts/sphinx-pre-install --version-check 101cb43fb57SMauro Carvalho Chehab @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var))) 102cb43fb57SMauro Carvalho Chehab 103cb43fb57SMauro Carvalho Chehabxmldocs: 1049b88ad54SMauro Carvalho Chehab @./scripts/sphinx-pre-install --version-check 105cb43fb57SMauro Carvalho Chehab @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var))) 106cb43fb57SMauro Carvalho Chehab 107cb43fb57SMauro Carvalho Chehabendif # HAVE_SPHINX 108cb43fb57SMauro Carvalho Chehab 109cb43fb57SMauro Carvalho Chehab# The following targets are independent of HAVE_SPHINX, and the rules should 110cb43fb57SMauro Carvalho Chehab# work or silently pass without Sphinx. 111cb43fb57SMauro Carvalho Chehab 112e8939222SJani Nikularefcheckdocs: 113e8939222SJani Nikula $(Q)cd $(srctree);scripts/documentation-file-ref-check 114e8939222SJani Nikula 115cb43fb57SMauro Carvalho Chehabcleandocs: 116cb43fb57SMauro Carvalho Chehab $(Q)rm -rf $(BUILDDIR) 117cb43fb57SMauro Carvalho Chehab $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media clean 118cb43fb57SMauro Carvalho Chehab 119cb43fb57SMauro Carvalho Chehabdochelp: 120cb43fb57SMauro Carvalho Chehab @echo ' Linux kernel internal documentation in different formats from ReST:' 121cb43fb57SMauro Carvalho Chehab @echo ' htmldocs - HTML' 122cb43fb57SMauro Carvalho Chehab @echo ' latexdocs - LaTeX' 123cb43fb57SMauro Carvalho Chehab @echo ' pdfdocs - PDF' 124cb43fb57SMauro Carvalho Chehab @echo ' epubdocs - EPUB' 125cb43fb57SMauro Carvalho Chehab @echo ' xmldocs - XML' 126cb43fb57SMauro Carvalho Chehab @echo ' linkcheckdocs - check for broken external links (will connect to external hosts)' 127e8939222SJani Nikula @echo ' refcheckdocs - check for references to non-existing files under Documentation' 128cb43fb57SMauro Carvalho Chehab @echo ' cleandocs - clean all generated files' 129cb43fb57SMauro Carvalho Chehab @echo 130cb43fb57SMauro Carvalho Chehab @echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2' 131cb43fb57SMauro Carvalho Chehab @echo ' valid values for SPHINXDIRS are: $(_SPHINXDIRS)' 132cb43fb57SMauro Carvalho Chehab @echo 133cb43fb57SMauro Carvalho Chehab @echo ' make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build' 134cb43fb57SMauro Carvalho Chehab @echo ' configuration. This is e.g. useful to build with nit-picking config.' 1359effc8f7SShuah Khan @echo 1369effc8f7SShuah Khan @echo ' Default location for the generated documents is Documentation/output' 137