Doc generation from annotated source code

L

Laszlo Nagy

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
 
N

Ned Batchelder

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.
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Members online

No members online now.

Forum statistics

Threads
473,766
Messages
2,569,569
Members
45,043
Latest member
CannalabsCBDReview

Latest Threads

Top