[python-numpy-doc] missing documentation

[Martin Lutz]

Binary package hint: python-numpy

the package contains no documentation in human readable format (txt, html, pdf, or similar) but instead contains source code.

ProblemType: Bug
Architecture: i386
Date: Thu Mar 4 14:55:58 2010
Dependencies:

DistroRelease: Ubuntu 9.10
NonfreeKernelModules: nvidia
Package: python-numpy-doc 1:1.3.0-3
PackageArchitecture: all
ProcEnviron:
 PATH=(custom, no user)
 LANG=en_US.UTF-8
 SHELL=/bin/bash
ProcVersionSignature: Ubuntu 2.6.31-19.56-generic
SourcePackage: python-numpy
Uname: Linux 2.6.31-19-generic i686

[malev (marcosvanetta)]

Hello, I'm sorry, I cant understand your report.
could you attach and example of what you say?
regards
malev

[Martin Lutz (m-lutz)]

In the package python-numpy-doc all files are *.py or *.py.gz which are filenames of python source code.
The homepage of numpy contains the documentation in html and in pdf format (user guide and reference guide), which is more useful and also much more complete. There are 1865 html-files in the reference guide on the numpy-homepage compared to 18 py-files in the ubuntu package.

dpkg -L python-numpy-doc
/.
/usr
/usr/share
/usr/share/doc
/usr/share/doc/python-numpy-doc
/usr/share/doc/python-numpy-doc/copyright
/usr/share/doc/python-numpy-doc/basics.py.gz
/usr/share/doc/python-numpy-doc/__init__.py
/usr/share/doc/python-numpy-doc/constants.py.gz
/usr/share/doc/python-numpy-doc/creation.py.gz
/usr/share/doc/python-numpy-doc/glossary.py.gz
/usr/share/doc/python-numpy-doc/indexing.py.gz
/usr/share/doc/python-numpy-doc/howtofind.py
/usr/share/doc/python-numpy-doc/misc.py.gz
/usr/share/doc/python-numpy-doc/ufuncs.py.gz
/usr/share/doc/python-numpy-doc/io.py
/usr/share/doc/python-numpy-doc/jargon.py
/usr/share/doc/python-numpy-doc/methods_vs_functions.py
/usr/share/doc/python-numpy-doc/performance.py
/usr/share/doc/python-numpy-doc/subclassing.py.gz
/usr/share/doc/python-numpy-doc/changelog.Debian.gz
/usr/share/doc/python-numpy-doc/broadcasting.py.gz
/usr/share/doc/python-numpy-doc/internals.py.gz
/usr/share/doc/python-numpy-doc/structured_arrays.py.gz

-----Original Message-----
From: <email address hidden> on behalf of malev
Sent: Mon 3/15/2010 5:14 PM
To: Lutz, M. (Martin)
Subject: [Bug 531917] Re: python-numpy-doc not human readable

Hello, I'm sorry, I cant understand your report.
could you attach and example of what you say?
regards
malev

** Changed in: python-numpy (Ubuntu)
       Status: New => Incomplete

--
python-numpy-doc not human readable
https://bugs.launchpad.net/bugs/531917
You received this bug notification because you are a direct subscriber
of the bug.

Status in "python-numpy" package in Ubuntu: Incomplete

Bug description:
Binary package hint: python-numpy

the package contains no documentation in human readable format (txt, html, pdf, or similar) but instead contains source code.

ProblemType: Bug
Architecture: i386
Date: Thu Mar 4 14:55:58 2010
Dependencies:

DistroRelease: Ubuntu 9.10
NonfreeKernelModules: nvidia
Package: python-numpy-doc 1:1.3.0-3
PackageArchitecture: all
ProcEnviron:
 PATH=(custom, no user)
 LANG=en_US.UTF-8
 SHELL=/bin/bash
ProcVersionSignature: Ubuntu 2.6.31-19.56-generic
SourcePackage: python-numpy
Uname: Linux 2.6.31-19-generic i686

To unsubscribe from this bug, go to:
https://bugs.launchpad.net/ubuntu/+source/python-numpy/+bug/531917/+subscribe

[malev (marcosvanetta)]

Hi there!
I agree with you, those files are estrange. I also ask at the scipy IRC channel, and they don't have a clue about them.
I'm gonna mark the bug as valid. And I'll make the upstream as soon as I can.
regards
malev

[malev (marcosvanetta)]

Take a look here: http://projects.scipy.org/numpy/ticket/1430

[Martin Lutz (m-lutz)]

Just a small additional comment: I have the impression that the files of package python-numpy-doc (stored in /usr/share/doc/python-numpy-doc) are already contained in the package python-numpy (stored in /usr/share/doc/python-numpy). So there seems to be no additional value of the doc-package in the moment.

[sam tygier (samtygier)]

if you look in the files /usr/share/doc/python-numpy-doc/basics.py.gz you can see that it is a docstring containing restructured text. these need to be built using Sphinx. see http://projects.scipy.org/numpy/browser/trunk/doc/HOWTO_BUILD_DOCS.txt

[malev (marcosvanetta)]

shouldn't them allready be built?

[Martin Lutz (m-lutz)]

I certainly prefer a pre-built documentation instead of "compiling" it myself.

The suggested document http://projects.scipy.org/numpy/browser/trunk/doc/HOWTO_BUILD_DOCS.txt does not apply to the situation in ubuntu. The document assumes that numpy is installed from the sources and that the corresponding Makefiles are present. I have installed numpy from the binary ubuntu package. Therefore I do not have the Makefile to "compile" the documentation.

[Pauli Virtanen (pauli-virtanen)]

To be more clear (I'm an upstream developer):

Ubuntu should

(i) Build the HTML documentation using doc/Makefile, and put that into the python-numpy-doc package. How to do this is explained in detail in doc/HOWTO_BUILD_DOCS.txt

(ii) The numpy/doc/*.py files contain some runtime help. These should be included in the python-numpy package ("python setup.py install" installs in them in the correct location), and they should not be shipped separately.

[Julian Taylor (jtaylor)]

the plots should now be built (minus some plots, see bug 721007)