Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.python > #59903 > unrolled thread

Re: Doc generation from annotated source code

Back to article view | Back to comp.lang.python

This discussion starts older than the indexed window; earlier articles aren't shown. The article labeled Started by below is the oldest one visible, not the original post.

Contents

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

#59903 — Re: Doc generation from annotated source code

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

[toc] | [standalone]

Back to top | Article view | comp.lang.python

csiph-web