← Back to team overview

ubuntu-packaging-guide-team team mailing list archive

lp:~andrewsomething/ubuntu-packaging-guide/fix-singlehtml-for-new-sphinx-version into lp:ubuntu-packaging-guide

 

Andrew Starr-Bochicchio has proposed merging lp:~andrewsomething/ubuntu-packaging-guide/fix-singlehtml-for-new-sphinx-version into lp:ubuntu-packaging-guide.

Requested reviews:
  Ubuntu Packaging Guide Team (ubuntu-packaging-guide-team)

For more details, see:
https://code.launchpad.net/~andrewsomething/ubuntu-packaging-guide/fix-singlehtml-for-new-sphinx-version/+merge/101770

sphinx 1.1.3 is now in precise. It fixes a bug [1] in generating the singlehtml builds that I was working around in the Makefile. singlehtml is currently broken when built against sphinx 1.1.3. This adjusts the sed processing of  singlehtml/index.html to deal with the changes.

I've backported sphinx 1.1.3 in the PPA so we can keep using the same branch of the guide to build on all dists.

[1] https://bitbucket.org/birkenfeld/sphinx/issue/892/broken-singlehtml-when-files-are-in
-- 
https://code.launchpad.net/~andrewsomething/ubuntu-packaging-guide/fix-singlehtml-for-new-sphinx-version/+merge/101770
Your team Ubuntu Packaging Guide Team is requested to review the proposed merge of lp:~andrewsomething/ubuntu-packaging-guide/fix-singlehtml-for-new-sphinx-version into lp:ubuntu-packaging-guide.
=== modified file 'Makefile'
--- Makefile	2012-03-20 16:21:33 +0000
+++ Makefile	2012-04-12 16:23:28 +0000
@@ -52,7 +52,7 @@
 	sed -i 's/href="..\//href=".\//g' $(BUILDDIR)/html/*html
 	sed -i 's/..\/_images/.\/_images/g' $(BUILDDIR)/html/*html
 	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/en"
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html"
 html-%: locale
 	$(SPHINXBUILD) -Dlanguage=$* -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html/$*
 	mv $(BUILDDIR)/html/$*/ubuntu-packaging-guide/*html  $(BUILDDIR)/html/$*
@@ -72,18 +72,18 @@
 
 singlehtml: $(foreach lang,$(LANGS),singlehtml-$(lang))
 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
-	sed -i 's/..\/..\//.\//g' _build/singlehtml/ubuntu-packaging-guide/index.html
-	sed -i 's/ubuntu-packaging-guide\/index/index/g' _build/singlehtml/ubuntu-packaging-guide/index.html
 	mv $(BUILDDIR)/singlehtml/ubuntu-packaging-guide/*html  $(BUILDDIR)/singlehtml
+	sed -i 's/href="..\//href=".\//g' $(BUILDDIR)/singlehtml/index.html
+	sed -i 's/ubuntu-packaging-guide\/index/index/g' $(BUILDDIR)/singlehtml/index.html
+	sed -i 's/..\/..\/_images/.\/_images/g' $(BUILDDIR)/singlehtml/index.html
 	@echo
-	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml/en"
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml"
 singlehtml-%: locale
 	$(SPHINXBUILD) -Dlanguage=$* -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml/$*
-	# Work around upstream bug in singlehtml generation:
-	# https://bitbucket.org/birkenfeld/sphinx/issue/892/broken-singlehtml-when-files-are-in
-	sed -i 's/..\/..\//.\//g' _build/singlehtml/$*/ubuntu-packaging-guide/index.html
-	sed -i 's/ubuntu-packaging-guide\/index/index/g' _build/singlehtml/$*/ubuntu-packaging-guide/index.html
 	mv $(BUILDDIR)/singlehtml/$*/ubuntu-packaging-guide/*html  $(BUILDDIR)/singlehtml/$*
+	sed -i 's/href="..\//href=".\//g' $(BUILDDIR)/singlehtml/$*/index.html
+	sed -i 's/ubuntu-packaging-guide\/index/index/g' $(BUILDDIR)/singlehtml/$*/index.html
+	sed -i 's/..\/..\/_images/.\/_images/g' $(BUILDDIR)/singlehtml/$*/index.html
 	@echo
 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml/$*."
 


Follow ups