forked from torvalds/linux
-
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 branch 'sphinx-for-docs-next' into doc/4.8
Jani Nikula says: Jon, this is v2 of [1] and [2], with a considerable amount of polish and fixes added. We started dogfooding this within drm-intel, and Daniel has reviewed the lot and contributed a number of fixes, most notably accurate file and line number references from Sphinx build errors/warnings to the kernel-doc comments in source code. We believe this is now in good shape for merging for v4.8. It's all in my sphinx-for-docs-next branch that you've already looked at; pull details below. When this lands in docs-next and we can backmerge to drm, we'll plunge ahead and convert gpu.tmpl to rst, and have that ready for v4.8. We think it's best to contribute that via the drm tree, as it'll involve splitting up the documentation and likely numerous updates to kernel-doc comments. I plan to update Documentation/kernel-doc-nano-HOWTO.txt for Sphinx and rst, obviously converting it to rst while at it.
- Loading branch information
Showing
11 changed files
with
948 additions
and
144 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.