[linux] 01/01: linux-doc: Build and install HTML pages from reStructuredText sources

[debian-kernel at lists.debian.org]

This is an automated email from the git hooks/post-receive script.

benh pushed a commit to branch master
in repository linux.

commit 7a4881e4d1723f80254e14f49614a8c90ef5996a
Author: Ben Hutchings <ben at decadent.org.uk>
Date:   Sat Sep 3 01:42:06 2016 +0100

    linux-doc: Build and install HTML pages from reStructuredText sources
    
    - Add python-sphinx and python-sphinx-rtd-theme to Build-Depends-Indep
    - Install files from both HTML output directories into the package
    - Exclude RST sources from the package
---
 debian/changelog                   |  4 ++++
 debian/rules.real                  | 14 ++++++++++++--
 debian/templates/control.source.in |  2 ++
 3 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 84f6c7e..86d0e36 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -29,6 +29,10 @@ linux (4.8~rc4-1~exp1) UNRELEASED; urgency=medium
     - [armhf] Enable IIO_ST_ACCEL_3AXIS as module instead of LIS3L02DQ
     * [hppa] Enable RTC_CLASS and RTC_DRV_GENERIC instead of GEN_RTC
   * liblockdep: Stop trying to build packages, as it failed to build again
+  * linux-doc: Build and install HTML pages from reStructuredText sources
+    - Add python-sphinx and python-sphinx-rtd-theme to Build-Depends-Indep
+    - Install files from both HTML output directories into the package
+    - Exclude RST sources from the package
 
  -- Ben Hutchings <ben at decadent.org.uk>  Sun, 28 Aug 2016 19:01:59 +0100
 
diff --git a/debian/rules.real b/debian/rules.real
index 81a6a17..e320c82 100644
--- a/debian/rules.real
+++ b/debian/rules.real
@@ -222,12 +222,22 @@ install-doc: $(STAMPS_DIR)/build-doc
 	mkdir -p $(OUT_DIR)
 	set -o pipefail; \
 	find CREDITS MAINTAINERS README REPORTING-BUGS Documentation \
-		-name '.gitignore' -prune -o -name DocBook -prune -o -print | \
+		-name '.gitignore' -prune -o -name DocBook -prune -o \
+		-name '*.rst' -prune -o -path Documentation/media -prune -o \
+		-print | \
 	cpio -pd --preserve-modification-time '$(CURDIR)/$(OUT_DIR)'
+# Some HTML pages are generated by xmlto from DocBook XML and some by
+# Sphinx from reStructedText.  Unfortunately these each generate their
+# own top level index.html, so we put them in two separate
+# subdirectories until the conversion to RST is complete.
 	set -o pipefail; \
 	cd $(DIR)/Documentation/DocBook; \
 	find * -name '*.html' -print | \
-	cpio -pd --preserve-modification-time '$(CURDIR)/$(OUT_DIR)/html'
+	cpio -pd --preserve-modification-time '$(CURDIR)/$(OUT_DIR)/html/oldstyle'
+	set -o pipefail; \
+	cd $(DIR)/Documentation/output/html; \
+	find * -name objects.inv -prune -o -print | \
+	cpio -pd --preserve-modification-time '$(CURDIR)/$(OUT_DIR)/html/newstyle'
 	gzip -9nqfr $(OUT_DIR)/Documentation
 	+$(MAKE_SELF) install-base
 
diff --git a/debian/templates/control.source.in b/debian/templates/control.source.in
index 21e93a3..070db66 100644
--- a/debian/templates/control.source.in
+++ b/debian/templates/control.source.in
@@ -58,6 +58,8 @@ Build-Depends-Indep:
 # used by debian/rules.real to build linux-source
  patchutils <!stage1>,
 # used by upstream to build documentation
+ python-sphinx <!stage1 !nodoc>,
+ python-sphinx-rtd-theme <!stage1 !nodoc>,
  xmlto <!stage1 !nodoc>,
 Vcs-Git: https://anonscm.debian.org/git/kernel/linux.git
 Vcs-Browser: https://anonscm.debian.org/cgit/kernel/linux.git

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/kernel/linux.git