[mirror_ubuntu-artful-kernel.git] / Documentation / Makefile.sphinx

# -*- makefile -*-
# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXBUILD   = sphinx-build
SPHINXOPTS    =
PAPER         =
BUILDDIR      = $(obj)/output

# User-friendly check for sphinx-build
HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi)

ifeq ($(HAVE_SPHINX),0)

.DEFAULT:
	$(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.)
	@echo "  SKIP    Sphinx $@ target."

else ifneq ($(DOCBOOKS),)

# Skip Sphinx build if the user explicitly requested DOCBOOKS.
.DEFAULT:
	@echo "  SKIP    Sphinx $@ target (DOCBOOKS specified)."

else # HAVE_SPHINX

# User-friendly check for rst2pdf
HAVE_RST2PDF := $(shell if python -c "import rst2pdf" >/dev/null 2>&1; then echo 1; else echo 0; fi)

# Internal variables.
PAPEROPT_a4     = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
KERNELDOC       = $(srctree)/scripts/kernel-doc
KERNELDOC_CONF  = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)
ALLSPHINXOPTS   = -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) -d $(BUILDDIR)/.doctrees $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) -c $(srctree)/$(src) $(SPHINXOPTS) $(srctree)/$(src)
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

quiet_cmd_sphinx = SPHINX  $@
      cmd_sphinx = BUILDDIR=$(BUILDDIR) $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2

htmldocs:
	$(MAKE) BUILDDIR=$(BUILDDIR) -f $(srctree)/Documentation/media/Makefile $@
	$(call cmd,sphinx,html)

pdfdocs:
ifeq ($(HAVE_RST2PDF),0)
	$(warning The Python 'rst2pdf' module was not found. Make sure you have the module installed to produce PDF output.)
	@echo "  SKIP    Sphinx $@ target."
else # HAVE_RST2PDF
	$(call cmd,sphinx,pdf)
endif # HAVE_RST2PDF

epubdocs:
	$(call cmd,sphinx,epub)

xmldocs:
	$(call cmd,sphinx,xml)

# no-ops for the Sphinx toolchain
sgmldocs:
psdocs:
mandocs:
installmandocs:
cleanmediadocs:

cleandocs:
	$(Q)rm -rf $(BUILDDIR)

dochelp:
	@echo  ' Linux kernel internal documentation in different formats (Sphinx):'
	@echo  '  htmldocs        - HTML'
	@echo  '  pdfdocs         - PDF'
	@echo  '  epubdocs        - EPUB'
	@echo  '  xmldocs         - XML'
	@echo  '  cleandocs       - clean all generated files'

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