-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge tag 'sphinx-4.8' of git://git.lwn.net/linux into topic/drm-misc
Stable tag for sphinx work Pull current state of the sphinx rework from Jonathan into drm-misc so that we can start converting gpu.tmpl. Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
- Loading branch information
Showing
17 changed files
with
1,326 additions
and
393 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
output |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# -*- 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 # 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 = $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2 | ||
|
||
htmldocs: | ||
$(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: | ||
|
||
cleandocs: | ||
$(Q)rm -rf $(BUILDDIR) | ||
|
||
endif # HAVE_SPHINX |
Oops, something went wrong.