Doc generation from annotated source code

Path	csiph.com!usenet.pasdenom.info!gegeweb.org!usenet-fr.net!nerim.net!novso.com!newsfeed.xs4all.nl!newsfeed2.news.xs4all.nl!xs4all!post.news.xs4all.nl!not-for-mail
Return-Path	<gandalf@shopzeus.com>
X-Original-To	python-list@python.org
Delivered-To	python-list@mail.python.org
X-Spam-Status	OK 0.010
X-Spam-Evidence	'H': 0.98; 'S': 0.00; 'subject:code': 0.07; 'clean.': 0.09; 'okay': 0.09; 'parameter': 0.09; 'python': 0.11; 'project,': 0.12; 'annotations.': 0.16; 'code?': 0.16; 'docstrings': 0.16; 'mailscanner,': 0.16; 'sphinx.': 0.16; 'subject:generation': 0.16; 'previously': 0.22; 'this?': 0.23; 'header:User-Agent:1': 0.23; 'question': 0.24; 'source': 0.25; 'scanned': 0.29; 'documenting': 0.31; 'everywhere': 0.31; 'noticed': 0.34; 'subject:from': 0.34; 'convert': 0.35; 'but': 0.35; 'there': 0.35; 'believed': 0.36; 'thanks': 0.36; 'should': 0.36; 'project': 0.37; 'auto': 0.38; 'to:addr:python-list': 0.38; 'to:addr:python.org': 0.39; 'dangerous': 0.60; 'new': 0.61; 'viruses': 0.61; 'kind': 0.63; 'subject:source': 0.84
Date	Mon, 18 Nov 2013 14:46:46 +0100
From	Laszlo Nagy <gandalf@shopzeus.com>
User-Agent	Mozilla/5.0 (X11; Linux x86_64; rv:24.0) Gecko/20100101 Thunderbird/24.1.0
MIME-Version	1.0
To	python-list@python.org
Subject	Doc generation from annotated source code
Content-Type	text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding	7bit
X-shopzeus-MailScanner-Information	Please contact the ISP for more information
X-shopzeus-MailScanner-ID	BC4D688973B9.AEBCC
X-shopzeus-MailScanner	Found to be clean
X-shopzeus-MailScanner-From	gandalf@shopzeus.com
X-Spam-Status	No
X-BeenThere	python-list@python.org
X-Mailman-Version	2.1.15
Precedence	list
List-Id	General discussion list for the Python programming language <python-list.python.org>
List-Unsubscribe	<https://mail.python.org/mailman/options/python-list>, <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive	<http://mail.python.org/pipermail/python-list/>
List-Post	<mailto:python-list@python.org>
List-Help	<mailto:python-list-request@python.org?subject=help>
List-Subscribe	<https://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
Newsgroups	comp.lang.python
Message-ID	<mailman.2846.1384782415.18130.python-list@python.org> (permalink)
Lines	14
NNTP-Posting-Host	2001:888:2000:d::a6
X-Trace	1384782415 news.xs4all.nl 15998 [2001:888:2000:d::a6]:48505
X-Complaints-To	abuse@xs4all.nl
Xref	csiph.com comp.lang.python:59868

Show key headers only | View raw

I just started rewritting my project from python 2 to python 3. I 
noticed that there are these new parameter and return value annotations. 
I have docstrings everywhere in my project, but I plan to convert many 
of them into annotations. The question is: what kind of auto documenting 
system should I use for this? Previously I have used Sphinx. Is it okay 
to use that for python 3 source code? Is there a better alternative?

Thanks

-- 
This message has been scanned for viruses and
dangerous content by MailScanner, and is
believed to be clean.

Back to comp.lang.python | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

Doc generation from annotated source code Laszlo Nagy <gandalf@shopzeus.com> - 2013-11-18 14:46 +0100
  Re: Doc generation from annotated source code Ned Batchelder <ned@nedbatchelder.com> - 2013-11-18 14:56 -0800

csiph-web