[IPython-user] Docs for sh profile available

[Fernando Perez]

Hey,

On Sun, Mar 9, 2008 at 5:07 AM, Ville M. Vainio <vivainio@gmail.com> wrote:
> I started to flesh out the the sh profile documentation at:
>
>  http://ipython.scipy.org/moin/Cookbook/ShProfile
>
>  It already documents pretty much everything you need to know. Better
>  late than never, eh :-)

I'm still behind on a full report of the sprint and plans, and I doubt
I'll get to really catch up until after the Paris one in 2 weeekends,
but an important heads-up now that you've started writing docs: please
use reST for any new docs you write, even if they go in the wiki for
now.  Moin supports reST out of the box, just type

{{{
#!rst

YOUR REST HERE

}}}

into the Moin pages and you're set.  With your Sh and other docs in
reST, it will be much easier to then put them into the full
documentation, for which we're now using reST and which we'll build in
the end using Sphinx. Sphinx is the reST-based documentation system
that the Python team is using for Python 2.6:

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

By using the standard Python documentation system, we get great
consistency for end users and we don't have to reinvent a bunch of
wheels regarding reST tools (in Austin we rapidly ran into several
small problems which we then realized the python guys had already
encountered and solved).

So hopefully all new docs any of us write will be done in reST.

Cheers,

f