[IPython-user] ipython -p sh questions

[Fernando Perez]

Quick note:

On Tue, Mar 4, 2008 at 7:28 AM, James Spencer <jss43@cam.ac.uk> wrote:

>  Is there any more documentation on the shell profile apart from
>  http://ipython.scipy.org/moin/Cookbook/IpythonShell, or any in the
>  works?  I'm interested in contributing if the latter...

As Ville mentioned, the cookbook page would be great.  Please write it
using reST, and more specifically the new Python reST guidelines and
conventions:

http://docs.python.org/dev/documenting/index.html

For IPython1 we're writing all reST documents, and we'll be soon using
these tools so our docs are consistent with the Python ones (plus,
they did a bunch of work on top of distutils to solve several problems
we were dealing wiith).

The ipython1 docs are now auto-generated every night in html and pdf:

http://ipython.scipy.org/doc/ipython1/html/
http://ipython.scipy.org/doc/ipython1/manual.pdf

We haven't yet adapted our base reST to use the python shpinx
toolchain, but will over the next few days.  So for those working off
trunk, anything you document using reST and the python toolchain, will
be directly usable when we merge the entire codebase in a couple of
months.

Note that any wiki page can be fully written in reST, see

http://ipython.scipy.org/moin/FernandoPerez

and this is the source:

http://ipython.scipy.org/moin/FernandoPerez?action=raw

You basically just do

{{{
#!rst

reST away...

}}}


Cheers,

f