forked from Qortal/Brooklyn
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
157 lines
5.7 KiB
157 lines
5.7 KiB
# -*- makefile -*- |
|
# Makefile for Sphinx documentation |
|
# |
|
|
|
# for cleaning |
|
subdir- := devicetree/bindings |
|
|
|
# Check for broken documentation file references |
|
ifeq ($(CONFIG_WARN_MISSING_DOCUMENTS),y) |
|
$(shell $(srctree)/scripts/documentation-file-ref-check --warn) |
|
endif |
|
|
|
# Check for broken ABI files |
|
ifeq ($(CONFIG_WARN_ABI_ERRORS),y) |
|
$(shell $(srctree)/scripts/get_abi.pl validate --dir $(srctree)/Documentation/ABI) |
|
endif |
|
|
|
# You can set these variables from the command line. |
|
SPHINXBUILD = sphinx-build |
|
SPHINXOPTS = |
|
SPHINXDIRS = . |
|
_SPHINXDIRS = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst))) |
|
SPHINX_CONF = conf.py |
|
PAPER = |
|
BUILDDIR = $(obj)/output |
|
PDFLATEX = xelatex |
|
LATEXOPTS = -interaction=batchmode |
|
|
|
ifeq ($(KBUILD_VERBOSE),0) |
|
SPHINXOPTS += "-q" |
|
endif |
|
|
|
# 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 |
|
@$(srctree)/scripts/sphinx-pre-install |
|
@echo " SKIP Sphinx $@ target." |
|
|
|
else # HAVE_SPHINX |
|
|
|
# User-friendly check for pdflatex and latexmk |
|
HAVE_PDFLATEX := $(shell if which $(PDFLATEX) >/dev/null 2>&1; then echo 1; else echo 0; fi) |
|
HAVE_LATEXMK := $(shell if which latexmk >/dev/null 2>&1; then echo 1; else echo 0; fi) |
|
|
|
ifeq ($(HAVE_LATEXMK),1) |
|
PDFLATEX := latexmk -$(PDFLATEX) |
|
endif #HAVE_LATEXMK |
|
|
|
# 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 = $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) |
|
# the i18n builder cannot share the environment and doctrees with the others |
|
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . |
|
|
|
# commands; the 'cmd' from scripts/Kbuild.include is not *loopable* |
|
loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit; |
|
|
|
# $2 sphinx builder e.g. "html" |
|
# $3 name of the build subfolder / e.g. "userspace-api/media", used as: |
|
# * dest folder relative to $(BUILDDIR) and |
|
# * cache folder relative to $(BUILDDIR)/.doctrees |
|
# $4 dest subfolder e.g. "man" for man pages at userspace-api/media/man |
|
# $5 reST source folder relative to $(srctree)/$(src), |
|
# e.g. "userspace-api/media" for the linux-tv book-set at ./Documentation/userspace-api/media |
|
|
|
quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4) |
|
cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2 && \ |
|
PYTHONDONTWRITEBYTECODE=1 \ |
|
BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \ |
|
$(PYTHON3) $(srctree)/scripts/jobserver-exec \ |
|
$(CONFIG_SHELL) $(srctree)/Documentation/sphinx/parallel-wrapper.sh \ |
|
$(SPHINXBUILD) \ |
|
-b $2 \ |
|
-c $(abspath $(srctree)/$(src)) \ |
|
-d $(abspath $(BUILDDIR)/.doctrees/$3) \ |
|
-D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) \ |
|
$(ALLSPHINXOPTS) \ |
|
$(abspath $(srctree)/$(src)/$5) \ |
|
$(abspath $(BUILDDIR)/$3/$4) |
|
|
|
htmldocs: |
|
@$(srctree)/scripts/sphinx-pre-install --version-check |
|
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var))) |
|
|
|
linkcheckdocs: |
|
@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var))) |
|
|
|
latexdocs: |
|
@$(srctree)/scripts/sphinx-pre-install --version-check |
|
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,latex,$(var),latex,$(var))) |
|
|
|
ifeq ($(HAVE_PDFLATEX),0) |
|
|
|
pdfdocs: |
|
$(warning The '$(PDFLATEX)' command was not found. Make sure you have it installed and in PATH to produce PDF output.) |
|
@echo " SKIP Sphinx $@ target." |
|
|
|
else # HAVE_PDFLATEX |
|
|
|
pdfdocs: latexdocs |
|
@$(srctree)/scripts/sphinx-pre-install --version-check |
|
$(foreach var,$(SPHINXDIRS), \ |
|
$(MAKE) PDFLATEX="$(PDFLATEX)" LATEXOPTS="$(LATEXOPTS)" -C $(BUILDDIR)/$(var)/latex || exit; \ |
|
mkdir -p $(BUILDDIR)/$(var)/pdf; \ |
|
mv $(subst .tex,.pdf,$(wildcard $(BUILDDIR)/$(var)/latex/*.tex)) $(BUILDDIR)/$(var)/pdf/; \ |
|
) |
|
|
|
endif # HAVE_PDFLATEX |
|
|
|
epubdocs: |
|
@$(srctree)/scripts/sphinx-pre-install --version-check |
|
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,epub,$(var),epub,$(var))) |
|
|
|
xmldocs: |
|
@$(srctree)/scripts/sphinx-pre-install --version-check |
|
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var))) |
|
|
|
endif # HAVE_SPHINX |
|
|
|
# The following targets are independent of HAVE_SPHINX, and the rules should |
|
# work or silently pass without Sphinx. |
|
|
|
refcheckdocs: |
|
$(Q)cd $(srctree);scripts/documentation-file-ref-check |
|
|
|
cleandocs: |
|
$(Q)rm -rf $(BUILDDIR) |
|
$(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean |
|
|
|
dochelp: |
|
@echo ' Linux kernel internal documentation in different formats from ReST:' |
|
@echo ' htmldocs - HTML' |
|
@echo ' latexdocs - LaTeX' |
|
@echo ' pdfdocs - PDF' |
|
@echo ' epubdocs - EPUB' |
|
@echo ' xmldocs - XML' |
|
@echo ' linkcheckdocs - check for broken external links' |
|
@echo ' (will connect to external hosts)' |
|
@echo ' refcheckdocs - check for references to non-existing files under' |
|
@echo ' Documentation' |
|
@echo ' cleandocs - clean all generated files' |
|
@echo |
|
@echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2' |
|
@echo ' valid values for SPHINXDIRS are: $(_SPHINXDIRS)' |
|
@echo |
|
@echo ' make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build' |
|
@echo ' configuration. This is e.g. useful to build with nit-picking config.' |
|
@echo |
|
@echo ' Default location for the generated documents is Documentation/output'
|
|
|