Closed siso closed 9 years ago
Document functions, classes, methods, e.g. Sphinx examples:
https://pythonhosted.org/an_example_pypi_project/sphinx.html#function-definitions
.. function:: format_exception(etype, value, tb[, limit=None])
Format the exception with a traceback.
:param etype: exception type
:param value: exception value
:param tb: traceback object
:param limit: maximum number of stack frames to show
:type limit: integer or None
:rtype: list of strings
./rax-autoscaler/docs/_build/html/autoscale.html#module-autoscale
seems OK:
def exit_with_error(msg):
"""This function prints error message and exit with error.
:param msg: error message
:type name: str
:returns: 1 (int) -- the return code
"""
while module-auth has to be fixed:
/rax-autoscaler/docs/_build/html/auth.html#module-auth
def authenticate_credentials(self):
'''
authenticate with username and api-key
@identity_type 'rackspace', 'openstack'
@username
@apikey
@region LON,SYD,DFW, etc
'''
linked ReadTheDocs.org, you can view documentation on-line:
This might be of interest too:
Can you please work in 'release-0.2' branch (no "41-docs" branch needed for this)? Thanks! See: