Bug#629329: pu: package sphinx/0.6.6-3+squeeze1
Package: release.debian.org
Tags: squeeze
User: release.debian.org@packages.debian.org
Usertags: pu
I'd like to upload new version of Sphinx into s-p-u, which fixes
compatibility with jQuery >= 1.4. (Upstream ships a copy of jQuery
1.2.6, but in Debian we use the packaged one, which is 1.4.2 in
squeeze.)
There are 55 documentation packages in squeeze affected by this bug.
Unfortunately, the sole upload of Sphinx won't automatically fix them,
as they ship copies of broken javascript code. :(
Debdiff contains also some minor documentation improvements, which were
committed to our svn before the Squeeze release. Of course, I can undo
them if you don't think they are suitable for a stable update.
--
Jakub Wilk
diffstat for sphinx_0.6.6-3 sphinx_0.6.6-3+squeeze1
debian/patches/fix_jquery_1.4_incompatibility.patch | 16 +++++++++++++++
sphinx-0.6.6/debian/changelog | 13 ++++++++++++
sphinx-0.6.6/debian/patches/series | 1
sphinx-0.6.6/debian/rules | 5 +++-
sphinx-0.6.6/debian/sphinx-autogen.1 | 4 +--
sphinx-0.6.6/debian/sphinx-build.1 | 21 ++++++++++++--------
sphinx-0.6.6/debian/sphinx-quickstart.1 | 2 -
7 files changed, 50 insertions(+), 12 deletions(-)
diff -u sphinx-0.6.6/debian/sphinx-autogen.1 sphinx-0.6.6/debian/sphinx-autogen.1
--- sphinx-0.6.6/debian/sphinx-autogen.1
+++ sphinx-0.6.6/debian/sphinx-autogen.1
@@ -20,8 +20,8 @@
.SH DESCRIPTION
.B sphinx\-autogen
-is a frontend to the \fBsphinx.ext.autosummary.generate\fR it
-generates the ReStructuredText files from the \fBautosummary\fR
+is a frontend to \fBsphinx.ext.autosummary.generate\fR.
+It generates the ReStructuredText files from the \fBautosummary\fR
directives contained in the given input files.
The format of the \fBautosummary\fR directive is documented in the
diff -u sphinx-0.6.6/debian/sphinx-build.1 sphinx-0.6.6/debian/sphinx-build.1
--- sphinx-0.6.6/debian/sphinx-build.1
+++ sphinx-0.6.6/debian/sphinx-build.1
@@ -8,13 +8,15 @@
\fBsphinx-build\fR generates documentation from the files in \fIsourcedir\fR and places it
to the \fIoutdir\fR.
-\fBsphinx-build\fR looks for \fIsourcedir\fR/conf.py for the configuration settings.
+\fBsphinx-build\fR reads \fIsourcedir\fR/conf.py for the configuration settings.
\fBsphinx-quickstart\fR(1)
may be used to generate template files, including conf.py.
-\fBsphinx-build\fR can create documentation in different formats. Format is selected
-by specifying builder in command line and defaults to HTML. Builders can
-also perform other tasks related to the documentation processing.
+\fBsphinx-build\fR can create documentation in different formats.
+The output format is selected by specifying builder in command line and
+defaults to HTML.
+Builders can also perform other tasks related to the documentation
+processing.
List of available builders:
.TP
@@ -48,15 +50,18 @@
Select a builder. The default is \fBhtml\fR. See the full list of builders above.
.TP
\fIfilename\fR
-Force to generate documentation for the file.
+Only generate documentation from the source file specified.
+Additionally, this option forces regeneration.
.TP
\fB-a\fR
-Always write all output files.
+Write all output files.
(The default is to only write output files for new and changed source files.)
.TP
\fB-E\fR
-Don't use a saved environment, but rebuild it completely.
-(The default is to only read and parse source files that are new or have changed since the last run.)
+Don't use a saved environment (the structure caching all
+cross-references), but rebuild completely.
+(The default is to only read and parse source files that are new or have
+changed since the last run.)
.TP
\fB-t\fR \fItag\fR
Define the \fItag\fR. This is relevant for \[oq]only\[cq] directives that only include their content if this tag is set.
diff -u sphinx-0.6.6/debian/rules sphinx-0.6.6/debian/rules
--- sphinx-0.6.6/debian/rules
+++ sphinx-0.6.6/debian/rules
@@ -10,10 +10,13 @@
build: build-stamp
-build-stamp:
+build-stamp: patch
dh_testdir
+ # documentation cannot be easily built with move_static_files_outside_site-packages applied, so pop it:
+ quilt pop
mkdir -p _build/html
python sphinx-build.py doc _build/html
+ quilt push
touch build-stamp
clean: clean-patched unpatch
diff -u sphinx-0.6.6/debian/sphinx-quickstart.1 sphinx-0.6.6/debian/sphinx-quickstart.1
--- sphinx-0.6.6/debian/sphinx-quickstart.1
+++ sphinx-0.6.6/debian/sphinx-quickstart.1
@@ -5,7 +5,7 @@
.B sphinx-quickstart
.SH DESCRIPTION
sphinx-quickstart is the interactive tool which asks some questions about your
-Python project and then generates template documentation directory and sample
+Python project and then generates a template documentation directory and sample
Makefile to be used with \fBsphinx-build\fR(1).
.SH "SEE ALSO"
\fBsphinx-build\fR(1)
diff -u sphinx-0.6.6/debian/changelog sphinx-0.6.6/debian/changelog
--- sphinx-0.6.6/debian/changelog
+++ sphinx-0.6.6/debian/changelog
@@ -1,3 +1,16 @@
+sphinx (0.6.6-3+squeeze1) stable; urgency=low
+
+ [ Stefano Rivera ]
+ * Improve language and clarify options in manpages.
+
+ [ Jakub Wilk ]
+ * Backport upstream patch to fix incompatibility with jQuery >= 1.4
+ (closes: #628642). Thanks to Yaroslav Halchenko for the bug report.
+ * Apply patches (except move_static_files_outside_site-packages) before
+ building documentation.
+
+ -- Jakub Wilk <jwilk@debian.org> Sun, 05 Jun 2011 17:44:55 +0200
+
sphinx (0.6.6-3) unstable; urgency=low
* Add myself to uploaders.
diff -u sphinx-0.6.6/debian/patches/series sphinx-0.6.6/debian/patches/series
--- sphinx-0.6.6/debian/patches/series
+++ sphinx-0.6.6/debian/patches/series
@@ -1 +1,2 @@
+fix_jquery_1.4_incompatibility.patch
move_static_files_outside_site-packages.patch
only in patch2:
unchanged:
--- sphinx-0.6.6.orig/debian/patches/fix_jquery_1.4_incompatibility.patch
+++ sphinx-0.6.6/debian/patches/fix_jquery_1.4_incompatibility.patch
@@ -0,0 +1,16 @@
+Description: Fix compatibility with jQuery 1.4.
+Bug-Debian: http://bugs.debian.org/628642
+Origin: backport, https://bitbucket.org/birkenfeld/sphinx/changeset/72375ba800b6
+Last-Update: 2011-06-05
+
+--- a/sphinx/themes/basic/static/doctools.js
++++ b/sphinx/themes/basic/static/doctools.js
+@@ -67,7 +67,7 @@
+ if (node.nodeType == 3) {
+ var val = node.nodeValue;
+ var pos = val.toLowerCase().indexOf(text);
+- if (pos >= 0 && !jQuery.className.has(node.parentNode, className)) {
++ if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
+ var span = document.createElement("span");
+ span.className = className;
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
Reply to: