On 2016-04-04 01:26, George Trojan wrote:
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.

Is it anything to do with "spipe._doc_"? Should that be "spipe.__doc__"?

--
https://mail.python.org/mailman/listinfo/python-list

Reply via email to