Doc generation from annotated source code
Ned Batchelder
ned at nedbatchelder.com
Mon Nov 18 17:56:50 EST 2013
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.
More information about the Python-list
mailing list