Re: [Numpy-discussion] Module Index for numpy?

2010-01-25 Thread denis
On 17/01/2010 18:57, Wayne Watson wrote:
 I was just looking at the (Win) Python documentation via the Help on
 IDLE, and a Global Module Index. Does anything like that exist for
 numpy, matplotlib, scipy?

Wayne, folks,

   may I second the wish / the need for searching thousands of functions.

Fwiw, grep makes a crude but very fast source tree browser:
1) grep class + def + first docstring lines in numpy/...py (re, no import);
this looks like

-- numpy/compat/setupscons.py
def configuration(parent_package='',top_path=None):

-- numpy/core/arrayprint.py
def product(x, y): return x*y
def set_printoptions(precision=None, threshold=None, edgeitems=None,
def get_printoptions():
 Return the current print options.
def array2string(a, max_line_width = None, precision = None,
...

2) grep2 that, i.e. grep + previous ^-- line.
numpy.defs is 6k lines, 230k, grep time ~ .25 sec.


What do we really want --
  - a source browser GUI, pyqt or webbrowser
  - or a better text pydoc
  - or full-text search -- Robert Kern has suggested his Whoosh
?
We could get together a table of existing GUIs and desiderata,
sort by sum(features) / time-to-write-a-manual (not time-to-hack).
Or,
o'er forms of doc let fools contest,
what's best written is the best.

cheers
   -- denis

___
NumPy-Discussion mailing list
NumPy-Discussion@scipy.org
http://mail.scipy.org/mailman/listinfo/numpy-discussion


Re: [Numpy-discussion] Module Index for numpy?

2010-01-25 Thread josef . pktd
On Mon, Jan 25, 2010 at 11:28 AM, denis denis-bz...@t-online.de wrote:
 On 17/01/2010 18:57, Wayne Watson wrote:
 I was just looking at the (Win) Python documentation via the Help on
 IDLE, and a Global Module Index. Does anything like that exist for
 numpy, matplotlib, scipy?

 Wayne, folks,

   may I second the wish / the need for searching thousands of functions.

 Fwiw, grep makes a crude but very fast source tree browser:
 1) grep class + def + first docstring lines in numpy/...py (re, no import);
 this looks like

        -- numpy/compat/setupscons.py
        def configuration(parent_package='',top_path=None):

        -- numpy/core/arrayprint.py
        def product(x, y): return x*y
        def set_printoptions(precision=None, threshold=None, edgeitems=None,
        def get_printoptions():
             Return the current print options.
        def array2string(a, max_line_width = None, precision = None,
        ...

 2) grep2 that, i.e. grep + previous ^-- line.
 numpy.defs is 6k lines, 230k, grep time ~ .25 sec.


 What do we really want --
  - a source browser GUI, pyqt or webbrowser
  - or a better text pydoc
  - or full-text search -- Robert Kern has suggested his Whoosh
 ?
 We could get together a table of existing GUIs and desiderata,
 sort by sum(features) / time-to-write-a-manual (not time-to-hack).
 Or,
        o'er forms of doc let fools contest,
        what's best written is the best.

 cheers
   -- denis

htmlhelp (of the docs) has all of the above at least on Windows,
except for source browsing (I use spyder for functions that are source
accessible)

Isn't there a Linux equivalent?

I haven't use np.lookfor or np.source in a long time.

Josef


 ___
 NumPy-Discussion mailing list
 NumPy-Discussion@scipy.org
 http://mail.scipy.org/mailman/listinfo/numpy-discussion

___
NumPy-Discussion mailing list
NumPy-Discussion@scipy.org
http://mail.scipy.org/mailman/listinfo/numpy-discussion


Re: [Numpy-discussion] Module Index for numpy?

2010-01-25 Thread Pauli Virtanen
ma, 2010-01-25 kello 11:59 -0500, josef.p...@gmail.com kirjoitti:
[clip]
 htmlhelp (of the docs) has all of the above at least on Windows,
 except for source browsing (I use spyder for functions that are source
 accessible)
 
 Isn't there a Linux equivalent?

There's devhelp, qthelp, and also CHM viewers for Linux. Numpy docs can
be built for all of them [1], provided a new enough version of Sphinx.
No need to invent a new wheel, methinks.

Moreover, there is already a listing of functions by feature in the
refguide...

.. [1] 
http://sphinx.pocoo.org/latest/builders.html?highlight=devhelp#sphinx.builders.qthelp.QtHelpBuilder

-- 
Pauli Virtanen



___
NumPy-Discussion mailing list
NumPy-Discussion@scipy.org
http://mail.scipy.org/mailman/listinfo/numpy-discussion


[Numpy-discussion] Module Index for numpy?

2010-01-17 Thread Wayne Watson
I was just looking at the (Win) Python documentation via the Help on 
IDLE, and a Global Module Index. Does anything like that exist for 
numpy, matplotlib, scipy?

-- 
   Wayne Watson (Watson Adventures, Prop., Nevada City, CA)

 (121.015 Deg. W, 39.262 Deg. N) GMT-8 hr std. time)
  Obz Site:  39° 15' 7 N, 121° 2' 32 W, 2700 feet  

   I was thinking about how people seem to read the Bible
a whole lot more as they get older; then it dawned on 
me . . they're cramming for their final exam.
-- George Carlin
 
Web Page: www.speckledwithstars.net/

___
NumPy-Discussion mailing list
NumPy-Discussion@scipy.org
http://mail.scipy.org/mailman/listinfo/numpy-discussion


Re: [Numpy-discussion] Module Index for numpy?

2010-01-17 Thread David Goldsmith
Hi, Wayne.

They're not nearly as structured, but for the time being
(indefinitely? unless a volunteer steps forward to build something for
us more closely resembling the GMI), you could use the numpy and scipy
doc Wiki Milestones pages:

http://docs.scipy.org/numpy/Milestones/

http://docs.scipy.org/scipy/Milestones/

in this fashion.

DG

On Sun, Jan 17, 2010 at 9:57 AM, Wayne Watson
sierra_mtnv...@sbcglobal.net wrote:
 I was just looking at the (Win) Python documentation via the Help on
 IDLE, and a Global Module Index. Does anything like that exist for
 numpy, matplotlib, scipy?

 --
           Wayne Watson (Watson Adventures, Prop., Nevada City, CA)

             (121.015 Deg. W, 39.262 Deg. N) GMT-8 hr std. time)
              Obz Site:  39° 15' 7 N, 121° 2' 32 W, 2700 feet

           I was thinking about how people seem to read the Bible
            a whole lot more as they get older; then it dawned on
            me . . they're cramming for their final exam.
                                    -- George Carlin

                    Web Page: www.speckledwithstars.net/

 ___
 NumPy-Discussion mailing list
 NumPy-Discussion@scipy.org
 http://mail.scipy.org/mailman/listinfo/numpy-discussion

___
NumPy-Discussion mailing list
NumPy-Discussion@scipy.org
http://mail.scipy.org/mailman/listinfo/numpy-discussion


Re: [Numpy-discussion] Module Index for numpy?

2010-01-17 Thread josef . pktd
On Sun, Jan 17, 2010 at 2:19 PM, David Goldsmith
d.l.goldsm...@gmail.com wrote:
 Hi, Wayne.

 They're not nearly as structured, but for the time being
 (indefinitely? unless a volunteer steps forward to build something for
 us more closely resembling the GMI), you could use the numpy and scipy
 doc Wiki Milestones pages:

 http://docs.scipy.org/numpy/Milestones/

 http://docs.scipy.org/scipy/Milestones/

 in this fashion.

 DG

 On Sun, Jan 17, 2010 at 9:57 AM, Wayne Watson
 sierra_mtnv...@sbcglobal.net wrote:
 I was just looking at the (Win) Python documentation via the Help on
 IDLE, and a Global Module Index. Does anything like that exist for
 numpy, matplotlib, scipy?

 --
           Wayne Watson (Watson Adventures, Prop., Nevada City, CA)

             (121.015 Deg. W, 39.262 Deg. N) GMT-8 hr std. time)
              Obz Site:  39° 15' 7 N, 121° 2' 32 W, 2700 feet

           I was thinking about how people seem to read the Bible
            a whole lot more as they get older; then it dawned on
            me . . they're cramming for their final exam.
                                    -- George Carlin

                    Web Page: www.speckledwithstars.net/

 ___
 NumPy-Discussion mailing list
 NumPy-Discussion@scipy.org
 http://mail.scipy.org/mailman/listinfo/numpy-discussion

 ___
 NumPy-Discussion mailing list
 NumPy-Discussion@scipy.org
 http://mail.scipy.org/mailman/listinfo/numpy-discussion


the autogenerated indices are here and also in the htmlhelp

http://docs.scipy.org/doc/numpy/modindex.html

http://docs.scipy.org/doc/numpy/genindex.html

However, because of the package structure of numpy the modindex is not
as useful as the one for python.

I find the structure of routines, and the index search in the htmlhelp
more useful.

Josef
___
NumPy-Discussion mailing list
NumPy-Discussion@scipy.org
http://mail.scipy.org/mailman/listinfo/numpy-discussion