Re: Doc generation from annotated source code

Path	csiph.com!v102.xanadu-bbs.net!xanadu-bbs.net!feeder.erje.net!eu.feeder.erje.net!newsfeed.xs4all.nl!newsfeed2.news.xs4all.nl!xs4all!newsgate.cistron.nl!newsgate.news.xs4all.nl!post.news.xs4all.nl!not-for-mail
Return-Path	<mailman@hanez.org>
X-Original-To	python-list@python.org
Delivered-To	python-list@mail.python.org
X-Spam-Status	OK 0.019
X-Spam-Evidence	'H': 0.96; 'S': 0.00; 'subject:code': 0.07; 'okay': 0.09; 'parameter': 0.09; 'sphinx': 0.09; 'python': 0.11; 'project,': 0.12; 'annotations.': 0.16; 'code?': 0.16; 'docstrings': 0.16; 'received:dip0.t-ipconnect.de': 0.16; 'received:t-ipconnect.de': 0.16; 'sphinx.': 0.16; 'subject:generation': 0.16; 'wrote:': 0.18; 'seems': 0.21; 'previously': 0.22; 'this?': 0.23; 'mon,': 0.24; 'question': 0.24; 'source': 0.25; 'header:In-Reply-To:1': 0.27; 'documenting': 0.31; 'everywhere': 0.31; 'url:python': 0.33; 'noticed': 0.34; 'subject:from': 0.34; 'convert': 0.35; 'but': 0.35; 'there': 0.35; '+0100': 0.36; 'charset:us-ascii': 0.36; 'url:org': 0.36; 'should': 0.36; 'project': 0.37; 'auto': 0.38; 'nov': 0.38; 'to:addr:python-list': 0.38; 'to:addr:python.org': 0.39; 'received:org': 0.40; 'new': 0.61; 'url:3': 0.61; 'kind': 0.63; 'received:109': 0.72; 'nagy': 0.84; 'subject:source': 0.84; 'received:(helo localhost)': 0.91; '2013': 0.98
Date	Mon, 18 Nov 2013 21:23:15 +0100
From	Johannes Findeisen <mailman@hanez.org>
To	python-list@python.org
Subject	Re: Doc generation from annotated source code
In-Reply-To	<528A1A46.2090109@shopzeus.com>
References	<528A1A46.2090109@shopzeus.com>
X-Mailer	Claws Mail 3.9.0 (GTK+ 2.24.22; x86_64-pc-linux-gnu)
Mime-Version	1.0
Content-Type	text/plain; charset=US-ASCII
Content-Transfer-Encoding	7bit
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.2860.1384806291.18130.python-list@python.org> (permalink)
Lines	14
NNTP-Posting-Host	2001:888:2000:d::a6
X-Trace	1384806291 news.xs4all.nl 15976 [2001:888:2000:d::a6]:35830
X-Complaints-To	abuse@xs4all.nl
Xref	csiph.com comp.lang.python:59903

Show key headers only | View raw

On Mon, 18 Nov 2013 14:46:46 +0100
Laszlo Nagy wrote:

> 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?

The Python docs on http://docs.python.org/3/ are generated using Sphinx
so it seems OK to do so for Python 3... ;)

Johannes

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

Thread

Re: Doc generation from annotated source code Johannes Findeisen <mailman@hanez.org> - 2013-11-18 21:23 +0100

csiph-web