python - Getting sphinx to format def docstring -
i'm having trouble getting sphinx format docstrings in api. simple example this gist stripped down version of https://github.com/rocky/python2-trepan .
the command use in gist is:
sphinx-apidoc -o modules api.py
the docstring inside api.py looks this:
def debug(dbg_opts=none, start_opts=none, post_mortem=true, step_ignore=1, level=0): """ enter debugger. parameters ---------- level : how many stack frames go back. default 0. though there may calls in setup debugger may want skip. step_ignore : how many line events ignore after debug() call. 0 means don't wait debug() call finish. param dbg_opts : optional "options" dictionary gets fed trepan.debugger(); `start_opts' optional "options" dictionary gets fed trepan.debugger.core.start(). use this:: ... # possibly python code import trepan.api # needed once ... # possibly more python code trepan.api.debug() # can wrap inside conditional logic [etc.] """
Comments
Post a Comment