tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1# -*- makefile -*-
2# Makefile for Sphinx documentation
3#
4
5# You can set these variables from the command line.
6SPHINXBUILD = sphinx-build
7SPHINXOPTS =
8PAPER =
9BUILDDIR = $(obj)/output
10
11# User-friendly check for sphinx-build
12HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi)
13
14ifeq ($(HAVE_SPHINX),0)
15
16.DEFAULT:
17 $(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.)
18 @echo " SKIP Sphinx $@ target."
19
20else ifneq ($(DOCBOOKS),)
21
22# Skip Sphinx build if the user explicitly requested DOCBOOKS.
23.DEFAULT:
24 @echo " SKIP Sphinx $@ target (DOCBOOKS specified)."
25
26else # HAVE_SPHINX
27
28# User-friendly check for rst2pdf
29HAVE_RST2PDF := $(shell if python -c "import rst2pdf" >/dev/null 2>&1; then echo 1; else echo 0; fi)
30
31# Internal variables.
32PAPEROPT_a4 = -D latex_paper_size=a4
33PAPEROPT_letter = -D latex_paper_size=letter
34KERNELDOC = $(srctree)/scripts/kernel-doc
35KERNELDOC_CONF = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)
36ALLSPHINXOPTS = -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) -d $(BUILDDIR)/.doctrees $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) -c $(srctree)/$(src) $(SPHINXOPTS) $(srctree)/$(src)
37# the i18n builder cannot share the environment and doctrees with the others
38I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
39
40quiet_cmd_sphinx = SPHINX $@
41 cmd_sphinx = BUILDDIR=$(BUILDDIR) $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2
42
43htmldocs:
44 $(MAKE) BUILDDIR=$(BUILDDIR) -f $(srctree)/Documentation/media/Makefile $@
45 $(call cmd,sphinx,html)
46
47pdfdocs:
48ifeq ($(HAVE_RST2PDF),0)
49 $(warning The Python 'rst2pdf' module was not found. Make sure you have the module installed to produce PDF output.)
50 @echo " SKIP Sphinx $@ target."
51else # HAVE_RST2PDF
52 $(call cmd,sphinx,pdf)
53endif # HAVE_RST2PDF
54
55epubdocs:
56 $(call cmd,sphinx,epub)
57
58xmldocs:
59 $(call cmd,sphinx,xml)
60
61# no-ops for the Sphinx toolchain
62sgmldocs:
63psdocs:
64mandocs:
65installmandocs:
66
67cleandocs:
68 $(Q)rm -rf $(BUILDDIR)
69
70endif # HAVE_SPHINX
71
72dochelp:
73 @echo ' Linux kernel internal documentation in different formats (Sphinx):'
74 @echo ' htmldocs - HTML'
75 @echo ' pdfdocs - PDF'
76 @echo ' epubdocs - EPUB'
77 @echo ' xmldocs - XML'
78 @echo ' cleandocs - clean all generated files'