[Doc-SIG] Python docs in reST

Kenneth McDonald kenneth.m.mcdonald at gmail.com
Tue May 17 23:04:57 CEST 2005

On 5/16/05, doc-sig-request at python.org <doc-sig-request at python.org> wrote:
> Send Doc-SIG mailing list submissions to
>         doc-sig at python.org
> To subscribe or unsubscribe via the World Wide Web, visit
>         http://mail.python.org/mailman/listinfo/doc-sig
> or, via email, send a message with subject or body 'help' to
>         doc-sig-request at python.org
> You can reach the person managing the list at
>         doc-sig-owner at python.org
> When replying, please edit your Subject line so it is more specific
> than "Re: Contents of Doc-SIG digest..."
> Today's Topics:
>    1. Python docs in reST? (Skip Montanaro)
>    2. Re: Python docs in reST? (Michael Foord)

To me, the biggest single problem in Python documentation is that
there is no standard inline documentation format which has been
"blessed" as _the_ standard by the Python core development team. I
like Python much better than Ruby, but take a look at Ruby for a an
example of what kind of tools can be built once people have a standard
as a base. rubydoc is really, really nice

Whatever might be chosen or developed, we need IMHO a doc standard
that is part of the core python package, and comes with all of the
tools needed to use it.  Without this, documentation of python modules
is always going to be rather ad hoc.

Not that this was useful, but in any case if anyone wants to work
towards it... :-)


More information about the Doc-SIG mailing list