Menu

#456 Automatic ReST signature and page generation

open
nobody
5
2010-05-26
2010-05-26
Anonymous
No

ReST with sphinx has pretty much become the standard code documentation tool in the python community. I spend a lot of time going through and maintaining the signatures, module information and other elements of my docs. It would be great if pydev could do the following:

1. Automatically generate ReST signatures for all modules, functions and classes. For instance, if I have a module or class with the attributes a, b and c, generate the '.. attribute:' tags for a, b and c in the docstring. If I have a function with arguments foo and bar, generate ':param foo:' and ':param bar:'. If that function returns a value, generate a ':returns:' tag.
2. Have a documentation generation feature, where pydev automatically generates sphinx autodoc stubs for every module in your project.

Discussion

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.