Hi all, There is a bug report asking for the example files under doc/cython, doc/swig etc. to be included in the released binaries. This thread, http://thread.gmane.org/gmane.comp.python.numeric.general/26913/focus=26917, seems to indicate the docs should still be integrated in the main documentation. What do we want to do with the example files, are they still up to date? Ralf
Sat, 24 Jul 2010 18:22:33 +0800, Ralf Gommers wrote:
There is a bug report asking for the example files under doc/cython, doc/swig etc. to be included in the released binaries. This thread, http://thread.gmane.org/gmane.comp.python.numeric.general/26913/ focus=26917, seems to indicate the docs should still be integrated in the main documentation. What do we want to do with the example files, are they still up to date?
There are two points here, I guess: - the files should be integrated to the docs - some of them are also reusable as-is (cython/c_numpy.pxd, swig/numpy.i) for users in their own projects I'm not sure what's the best place to put these in. -- Pauli Virtanen
Sat, 24 Jul 2010 18:22:33 +0800, Ralf Gommers wrote:
There is a bug report asking for the example files under doc/cython, doc/swig etc. to be included in the released binaries. This thread, http://thread.gmane.org/gmane.comp.python.numeric.general/26913/ focus=26917<http://thread.gmane.org/gmane.comp.python.numeric.general/26913/%0Afocus=269...> , seems to indicate the docs should still be integrated in the main documentation. What do we want to do with the example files, are they still up to date?
There are two points here, I guess:
- the files should be integrated to the docs
The one file to be integrated is numpy_swig.txt. How about putting it into
On Sat, Jul 24, 2010 at 6:38 PM, Pauli Virtanen <pav@iki.fi> wrote: the reference guide as a separate chapter titled "Numpy and SWIG", right after "Numpy internals"? It's already in reST format so it's not much work. The swig/testing.txt file should probably not be included. Cython and Pyrex dirs do not have docs. - some of them are also reusable as-is (cython/c_numpy.pxd, swig/numpy.i)
for users in their own projects
I'm not sure what's the best place to put these in.
How about removing the swig html and pdf docs, and then including the swig/pyrex/cython dirs as-is? In setup.py:
config.add_data_files(('numpy','*.txt'), ('numpy','COMPATIBILITY'), - ('numpy','site.cfg.example')) + ('numpy','site.cfg.example'), + ('doc/cython/'), + ('doc/pyrex/'), + ('doc/swig/')) Cheers, Ralf
On Jul 31, 2010, at 12:32 AM, Ralf Gommers wrote:
How about removing the swig html and pdf docs, and then including the swig/pyrex/cython dirs as-is? In setup.py:
Note that the html and pdf documents are created from the txt file using the docutils utilities rts2html.py and rst2latex.py. ** Bill Spotz ** ** Sandia National Laboratories Voice: (505)845-0170 ** ** P.O. Box 5800 Fax: (505)284-0154 ** ** Albuquerque, NM 87185-0370 Email: wfspotz@sandia.gov **
On Sun, Aug 1, 2010 at 12:35 AM, Bill Spotz <wfspotz@sandia.gov> wrote:
On Jul 31, 2010, at 12:32 AM, Ralf Gommers wrote:
How about removing the swig html and pdf docs, and then including the
swig/pyrex/cython dirs as-is? In setup.py:
Note that the html and pdf documents are created from the txt file using
the docutils utilities rts2html.py and rst2latex.py.
Yes, that's why I propose to remove them. We have the sources in the repo and building the docs is easy. We do not keep pdf/html of any other docs in the repo. Everything else in the swig directory can then be included in the distributed binaries/tarballs, but the built docs would increase the size of the tarballs by 10%, which is a lot. Cheers, Ralf
On Sat, Jul 31, 2010 at 2:32 PM, Ralf Gommers <ralf.gommers@googlemail.com>wrote:
On Sat, Jul 24, 2010 at 6:38 PM, Pauli Virtanen <pav@iki.fi> wrote:
Sat, 24 Jul 2010 18:22:33 +0800, Ralf Gommers wrote:
There is a bug report asking for the example files under doc/cython, doc/swig etc. to be included in the released binaries. This thread, http://thread.gmane.org/gmane.comp.python.numeric.general/26913/ focus=26917<http://thread.gmane.org/gmane.comp.python.numeric.general/26913/%0Afocus=269...> , seems to indicate the docs should still be integrated in the main documentation. What do we want to do with the example files, are they still up to date?
There are two points here, I guess:
- the files should be integrated to the docs
The one file to be integrated is numpy_swig.txt. How about putting it into the reference guide as a separate chapter titled "Numpy and SWIG", right after "Numpy internals"? It's already in reST format so it's not much work.
The swig/testing.txt file should probably not be included. Cython and Pyrex dirs do not have docs.
Actually, testing.txt does look useful for the reference guide too, so I included it as well. This addresses both your points I think, please have a look: http://github.com/rgommers/numpy/commits/examples-swig-cython Cheers, Ralf
participants (3)
-
Bill Spotz -
Pauli Virtanen -
Ralf Gommers