Skip to content

Instantly share code, notes, and snippets.

@msiemens
Last active December 16, 2015 02:39
Show Gist options
  • Save msiemens/5363828 to your computer and use it in GitHub Desktop.
Save msiemens/5363828 to your computer and use it in GitHub Desktop.
Python Sphinx Inline Docs
def func(arg1, arg2):
"""
Summary.
Long explanation...
:param arg1: Descr for arg1
:type arg1: arg1 type
:param arg2: Descr for arg2
:type arg2: arg2 type
:raises IndexError: Descr of the exception
:returns: Descr of the return value
:rtype: return value type
:var var1: Describing an internal variable
"""
#: :type: some type
var1 = None
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment