[Numpy-discussion] ANN: NumPy/SciPy Documentation Marathon 2008

Pauli Virtanen pav@iki...
Sun May 18 08:28:47 CDT 2008


su, 2008-05-18 kello 07:16 -0600, Steven H. Rogers kirjoitti:
> Joe Harrington wrote:
> > ...
> > 5. Write a new help function that optionally produces ASCII or points
> > the user's PDF or HTML reader to the right page (either local or
> > global).
> >   
> I can work on this.  Fernando suggested this at the IPython sprint in 
> Boulder last year, so I've given it some thought and started a wiki page:
> http://ipython.scipy.org/moin/Developer_Zone/SearchDocs

In Numpy SVN/1.1 there is a function "lookfor" that searches the
docstrings for a substring (no stemming etc. is done). Similar 
"%lookfor" magic command got accepted into IPython0 as an extension
ipy_lookfor.py. Improvements to these would be surely appreciated.

I think that also Sphinx supports searching, so that the generated HTML
docs [1] are searchable, as is the generated PDF output.


.. [1] http://mentat.za.net/numpy/refguide/
   So far, this preview contains only docs for ndarray, though.

More information about the Numpy-discussion mailing list