[Tutor] Is pydoc the right API docs?

Kent Johnson kent37 at tds.net
Tue Nov 24 18:03:19 CET 2009


On Tue, Nov 24, 2009 at 11:43 AM, Rich Lovely <roadierich at googlemail.com> wrote:
> 11/24 Kent Johnson <kent37 at tds.net>:

>> pydoc just shows the docstrings. It does not include the full text of
>> the documentation. For that see
>> http://python.org/doc/

> Although, iirc the online docs are generated by pydoc.

No, they are created with Sphinx from reStructuredText source. Click
the Show Source link in the sidebar of any docs page to see.

The online docs do include much of the same text as the doc strings
but they are separately written and generated.

Kent


More information about the Tutor mailing list