[Tutor] Questions about the formatting of docstrings

boB Stepp robertvstepp at gmail.com
Fri Jul 27 13:23:00 EDT 2018

On Fri, Jul 27, 2018 at 12:50 AM Steven D'Aprano <steve at pearwood.info> wrote:
> On Thu, Jul 26, 2018 at 11:34:11PM -0500, boB Stepp wrote:

> > (1) The author claims that reStructuredText is the official Python
> > documentation standard.  Is this true?  If yes, is this something I
> > should be doing for my own projects?
> Yes, it is true. If you write documentation for the Python standard
> library, they are supposed to be in ReST. Docstrings you read in
> the interactive interpreter often aren't, but the documentation you read
> on the web page has all been automatically generated from ReST text
> files.

What tool is being used to generate the documentation from the ReST text files?


More information about the Tutor mailing list