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

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

Doc generation from annotated source code

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

Contents

  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

#59868 — Doc generation from annotated source code

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.

[toc] | [next] | [standalone]

#59915

On Monday, November 18, 2013 8:46:46 AM UTC-5, 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?
> 
> Thanks

If you don't know how to generate your docs yet, how have you decided that you want to change your docstrings into annotations?  Annotations have no standard semantics, so everyone using them is using them differently.

--Ned.

[toc] | [prev] | [standalone]

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

csiph-web