Merge lp:~barry/ubuntu/natty/python-numpy/bug-664276 into lp:ubuntu/natty/python-numpy

[Barry Warsaw]

Re-enable numpy documentation binary package, without requiring python-matplotlib dependency.

[Colin Watson (cjwatson)]

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2011-01-25 15:33:25 +0000
+++ debian/changelog	2011-02-10 20:32:38 +0000
@@ -1,3 +1,17 @@
+python-numpy (1:1.5.1-1ubuntu2) natty; urgency=low
+
+  * debian/rules, debian/control:
+    - Re-enable documentation binary package.  (LP: #664276)
+  * debian/control:
+    - Add python-sphinx to Build-Depends since it is required to build the
+      documentation.
+  * debian/patches/20_disable-plot-extension.patch
+    - Disable plot_directive extension, and catch ImportErrors when
+      matplotlib cannot be imported, which allows us to remove
+      python-matplotlib from dependencies.
+
+ -- Barry Warsaw <[e-mail]>  Thu, 10 Feb 2011 15:12:43 -0500
+
 python-numpy (1:1.5.1-1ubuntu1) natty; urgency=low
 
   * Merge from debian experimental (LP: #695005). Remaining changes:
 
=== modified file 'debian/control'
--- debian/control	2011-01-25 15:33:25 +0000
+++ debian/control	2011-02-10 20:32:38 +0000
@@ -4,7 +4,7 @@
 Maintainer: Ubuntu Developers <[e-mail]>
 XSBC-Original-Maintainer: Debian Python Modules Team <[e-mail]>
 Uploaders: Alexandre Fayolle <[e-mail]>, Matthias Klose <[e-mail]>, Ondrej Certik <[e-mail]>, David Cournapeau <[e-mail]>, Sandro Tosi <[e-mail]>
-Build-Depends: python-all-dev, python-all-dbg, python-support (>= 1), gfortran (>= 4:4.2), libblas-dev [!arm !m68k], liblapack-dev [!arm !m68k], debhelper (>= 7.0.50~), patchutils, python-docutils, quilt
+Build-Depends: python-all-dev, python-all-dbg, python-support (>= 1), gfortran (>= 4:4.2), libblas-dev [!arm !m68k], liblapack-dev [!arm !m68k], debhelper (>= 7.0.50~), patchutils, python-docutils, python-sphinx, quilt
 XS-Python-Version: >= 2.4
 Standards-Version: 3.9.1
 Vcs-Svn: svn://svn.debian.org/python-modules/packages/numpy/trunk
@@ -47,18 +47,18 @@
  .
  This package contains the extension built for the Python debug interpreter.
 
-#Package: python-numpy-doc
-#Depends: ${misc:Depends}, libjs-jquery
-#Section: doc
-#Architecture: all
-#Description: NumPy documentation
-# Numpy contains a powerful N-dimensional array object, sophisticated
-# (broadcasting) functions, tools for integrating C/C++ and Fortran
-# code, and useful linear algebra, Fourier transform, and random number
-# capabilities.
-# .
-# Numpy replaces the python-numeric and python-numarray modules which
-# are now deprecated and shouldn't be used except to support older
-# software.
-# .
-# This package contains documentation for Numpy and f2py.
+Package: python-numpy-doc
+Depends: ${misc:Depends}, libjs-jquery
+Section: doc
+Architecture: all
+Description: NumPy documentation
+ Numpy contains a powerful N-dimensional array object, sophisticated
+ (broadcasting) functions, tools for integrating C/C++ and Fortran
+ code, and useful linear algebra, Fourier transform, and random number
+ capabilities.
+ .
+ Numpy replaces the python-numeric and python-numarray modules which
+ are now deprecated and shouldn't be used except to support older
+ software.
+ .
+ This package contains documentation for Numpy and f2py.
 
=== added file 'debian/patches/20_disable-plot-extension.patch'
--- debian/patches/20_disable-plot-extension.patch	1970-01-01 00:00:00 +0000
+++ debian/patches/20_disable-plot-extension.patch	2011-02-10 20:32:38 +0000
@@ -0,0 +1,81 @@
+Description: Disable plot_directive and ignore any import errors when
+ importing matplotlib.  python-matplotlib is in universe and cannot be used
+ as a dependency.
+Author: Barry Warsaw <[e-mail]>
+Bug-Ubuntu: https://launchpad.net/bugs/664276
+=== modified file 'doc/source/conf.py'
+--- old/doc/source/conf.py	2010-12-24 00:14:25 +0000
++++ new/doc/source/conf.py	2011-02-10 17:23:52 +0000
+@@ -21,7 +21,8 @@
+ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.pngmath', 'numpydoc',
+               'sphinx.ext.intersphinx', 'sphinx.ext.coverage',
+               'sphinx.ext.doctest', 'sphinx.ext.autosummary',
+-              'plot_directive']
++              #'plot_directive']
++              ]
+ 
+ # Add any paths that contain templates here, relative to this directory.
+ templates_path = ['_templates']
+@@ -212,7 +213,7 @@
+ phantom_import_file = 'dump.xml'
+ 
+ # Make numpydoc to generate plots for example sections
+-numpydoc_use_plots = True
++numpydoc_use_plots = False
+ 
+ # -----------------------------------------------------------------------------
+ # Autosummary
+@@ -251,19 +252,23 @@
+ import math
+ phi = (math.sqrt(5) + 1)/2
+ 
+-import matplotlib
+-matplotlib.rcParams.update({
+-    'font.size': 8,
+-    'axes.titlesize': 8,
+-    'axes.labelsize': 8,
+-    'xtick.labelsize': 8,
+-    'ytick.labelsize': 8,
+-    'legend.fontsize': 8,
+-    'figure.figsize': (3*phi, 3),
+-    'figure.subplot.bottom': 0.2,
+-    'figure.subplot.left': 0.2,
+-    'figure.subplot.right': 0.9,
+-    'figure.subplot.top': 0.85,
+-    'figure.subplot.wspace': 0.4,
+-    'text.usetex': False,
+-})
++try:
++    import matplotlib
++except ImportError:
++    sys.stderr.write('matplotlib is not available; disabling plots\n')
++else:
++    matplotlib.rcParams.update({
++        'font.size': 8,
++        'axes.titlesize': 8,
++        'axes.labelsize': 8,
++        'xtick.labelsize': 8,
++        'ytick.labelsize': 8,
++        'legend.fontsize': 8,
++        'figure.figsize': (3*phi, 3),
++        'figure.subplot.bottom': 0.2,
++        'figure.subplot.left': 0.2,
++        'figure.subplot.right': 0.9,
++        'figure.subplot.top': 0.85,
++        'figure.subplot.wspace': 0.4,
++        'text.usetex': False,
++        })
+
+=== modified file 'doc/sphinxext/tests/test_docscrape.py'
+--- old/doc/sphinxext/tests/test_docscrape.py	2010-12-24 00:14:25 +0000
++++ new/doc/sphinxext/tests/test_docscrape.py	2011-02-10 17:23:52 +0000
+@@ -559,7 +559,7 @@
+     assert doc['Summary'][0] == u'öäöäöäöäöåååå'.encode('utf-8')
+ 
+ def test_plot_examples():
+-    cfg = dict(use_plots=True)
++    cfg = dict(use_plots=False)
+ 
+     doc = SphinxDocString("""
+     Examples
+
 
=== modified file 'debian/patches/series'
--- debian/patches/series	2011-01-25 15:33:25 +0000
+++ debian/patches/series	2011-02-10 20:32:38 +0000
@@ -3,3 +3,4 @@
 03_force_f2py_version.patch
 #05_fix_endianness_detection.patch
 10_use_local_python.org_object.inv_sphinx.diff
+20_disable-plot-extension.patch
 
=== modified file 'debian/rules'
--- debian/rules	2011-01-25 15:33:25 +0000
+++ debian/rules	2011-02-10 20:32:38 +0000
@@ -63,11 +63,11 @@
 	dh_link usr/share/doc/python-numpy usr/share/doc/python-numpy-dbg
 
 	# remove extra license in doc
-	#rm -f debian/python-numpy-doc/usr/share/doc/python-numpy-doc/html/_sources/license.txt
+	rm -f debian/python-numpy-doc/usr/share/doc/python-numpy-doc/html/_sources/license.txt
 
 	# use system-wide jquery
-	#rm -f debian/python-numpy-doc/usr/share/doc/python-numpy-doc/html/_static/jquery.js
-	#dh_link -ppython-numpy-doc /usr/share/javascript/jquery/jquery.js /usr/share/doc/python-numpy-doc/html/_static/jquery.js
+	rm -f debian/python-numpy-doc/usr/share/doc/python-numpy-doc/html/_static/jquery.js
+	dh_link -ppython-numpy-doc /usr/share/javascript/jquery/jquery.js /usr/share/doc/python-numpy-doc/html/_static/jquery.js
 
 	# create the pydist file
 	mkdir -p debian/python-numpy/usr/share/python/dist/
@@ -110,8 +110,8 @@
 
 build-indep: 
 	# build doc only for default python version
-	#(export MPLCONFIGDIR=. ; make -C doc html PYTHONPATH=../$(PYLIBPATH))
-	#rst2html numpy/f2py/docs/usersguide/index.txt > numpy/f2py/docs/usersguide/index.html
+	(export MPLCONFIGDIR=. ; make -C doc html PYTHONPATH=../$(PYLIBPATH))
+	rst2html numpy/f2py/docs/usersguide/index.txt > numpy/f2py/docs/usersguide/index.html
 
 update_intersphinx_mapping:
 	wget http://docs.python.org/dev/objects.inv -O debian/python.org_objects.inv
 
=== modified file 'doc/source/conf.py'
--- doc/source/conf.py	2010-12-24 00:14:25 +0000
+++ doc/source/conf.py	2011-02-10 20:32:38 +0000
@@ -21,7 +21,8 @@
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.pngmath', 'numpydoc',
               'sphinx.ext.intersphinx', 'sphinx.ext.coverage',
               'sphinx.ext.doctest', 'sphinx.ext.autosummary',
-              'plot_directive']
+              #'plot_directive']
+              ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -212,7 +213,7 @@
 phantom_import_file = 'dump.xml'
 
 # Make numpydoc to generate plots for example sections
-numpydoc_use_plots = True
+numpydoc_use_plots = False
 
 # -----------------------------------------------------------------------------
 # Autosummary
@@ -251,19 +252,23 @@
 import math
 phi = (math.sqrt(5) + 1)/2
 
-import matplotlib
-matplotlib.rcParams.update({
-    'font.size': 8,
-    'axes.titlesize': 8,
-    'axes.labelsize': 8,
-    'xtick.labelsize': 8,
-    'ytick.labelsize': 8,
-    'legend.fontsize': 8,
-    'figure.figsize': (3*phi, 3),
-    'figure.subplot.bottom': 0.2,
-    'figure.subplot.left': 0.2,
-    'figure.subplot.right': 0.9,
-    'figure.subplot.top': 0.85,
-    'figure.subplot.wspace': 0.4,
-    'text.usetex': False,
-})
+try:
+    import matplotlib
+except ImportError:
+    sys.stderr.write('matplotlib is not available; disabling plots\n')
+else:
+    matplotlib.rcParams.update({
+        'font.size': 8,
+        'axes.titlesize': 8,
+        'axes.labelsize': 8,
+        'xtick.labelsize': 8,
+        'ytick.labelsize': 8,
+        'legend.fontsize': 8,
+        'figure.figsize': (3*phi, 3),
+        'figure.subplot.bottom': 0.2,
+        'figure.subplot.left': 0.2,
+        'figure.subplot.right': 0.9,
+        'figure.subplot.top': 0.85,
+        'figure.subplot.wspace': 0.4,
+        'text.usetex': False,
+        })
 
=== modified file 'doc/sphinxext/tests/test_docscrape.py'
--- doc/sphinxext/tests/test_docscrape.py	2010-12-24 00:14:25 +0000
+++ doc/sphinxext/tests/test_docscrape.py	2011-02-10 20:32:38 +0000
@@ -559,7 +559,7 @@
     assert doc['Summary'][0] == u'öäöäöäöäöåååå'.encode('utf-8')
 
 def test_plot_examples():
-    cfg = dict(use_plots=True)
+    cfg = dict(use_plots=False)
 
     doc = SphinxDocString("""
     Examples