I'm trying to learn more than the common :param myparam: Some description
documentation style common in many python modules, but haven't been able to identify a full list of supported fieldnames. From examples, I've gathered param
, raises
, returns
.
def my_method(self, someval):
"""Returns one plus the given value
:param someval: an integer on which to operate
:whatelseisthere:
"""
return someval + 1
http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
The complete list of field names can be found here: