How to make sphinx to recognize functools.partial?
George Trojan
george.trojan at noaa.gov
Sun Apr 3 20:26:25 EDT 2016
Yet another sphinx question. I am a beginner here.
I can't make sphinx to recognize the following (abbreviated) code:
'''
module description
:func:`~pipe` and :func:`~spipe` read data passed by LDM's `pqact`.
'''
def _pipe(f, *args):
'''doc string'''
pass
def _get_msg_spipe():
'''another doc'''
pass
spipe = functools.partial(_pipe, _get_msg_spipe)
spipe._doc_ = '''
Loop over data feed on `stdin` from LDM via SPIPE.
'''
The word spipe is rendered correctly in html, but the link is not created.
I did put a print statement in sphinx/util/inspect.py, it appears that
spipe definition is not recognized. I am running sphinx 1.3.5, according
to CHANGELOG functools.partial support was added in 1.2.1.
George
More information about the Python-list
mailing list