blob: 810c11f0d37f486cb35fb65133c70616a005b035 [file] [log] [blame]
Jani Nikula22cba312016-05-19 15:14:05 +03001# -*- 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 # HAVE_SPHINX
21
22# User-friendly check for rst2pdf
23HAVE_RST2PDF := $(shell if python -c "import rst2pdf" >/dev/null 2>&1; then echo 1; else echo 0; fi)
24
25# Internal variables.
26PAPEROPT_a4 = -D latex_paper_size=a4
27PAPEROPT_letter = -D latex_paper_size=letter
Jani Nikula24dcdeb2016-05-20 11:51:47 +030028KERNELDOC = $(srctree)/scripts/kernel-doc
29KERNELDOC_CONF = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)
Jani Nikulac13ce442016-05-28 15:25:41 +030030ALLSPHINXOPTS = -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) -d $(BUILDDIR)/.doctrees $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) -c $(srctree)/$(src) $(SPHINXOPTS) $(srctree)/$(src)
Jani Nikula22cba312016-05-19 15:14:05 +030031# the i18n builder cannot share the environment and doctrees with the others
32I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
33
34quiet_cmd_sphinx = SPHINX $@
35 cmd_sphinx = $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2
36
37htmldocs:
38 $(call cmd,sphinx,html)
39
40pdfdocs:
41ifeq ($(HAVE_RST2PDF),0)
42 $(warning The Python 'rst2pdf' module was not found. Make sure you have the module installed to produce PDF output.)
43 @echo " SKIP Sphinx $@ target."
44else # HAVE_RST2PDF
45 $(call cmd,sphinx,pdf)
46endif # HAVE_RST2PDF
47
48epubdocs:
49 $(call cmd,sphinx,epub)
50
51xmldocs:
52 $(call cmd,sphinx,xml)
53
54# no-ops for the Sphinx toolchain
55sgmldocs:
56psdocs:
57mandocs:
58installmandocs:
59
60cleandocs:
61 $(Q)rm -rf $(BUILDDIR)
62
Jani Nikulaebc88ef2016-06-22 15:41:48 +030063dochelp:
64 @echo ' Linux kernel internal documentation in different formats (Sphinx):'
65 @echo ' htmldocs - HTML'
66 @echo ' pdfdocs - PDF'
67 @echo ' epubdocs - EPUB'
68 @echo ' xmldocs - XML'
69 @echo ' cleandocs - clean all generated files'
70
Jani Nikula22cba312016-05-19 15:14:05 +030071endif # HAVE_SPHINX