Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.python > #106421

Re: How to make sphinx to recognize functools.partial?

Show all headers | View raw

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__"?

Back to comp.lang.python | Previous | Next | Find similar | Unroll thread

Thread

Re: How to make sphinx to recognize functools.partial? MRAB <python@mrabarnett.plus.com> - 2016-04-04 01:42 +0100

csiph-web