Path: csiph.com!fu-berlin.de!uni-berlin.de!not-for-mail
From: MRAB <python@mrabarnett.plus.com>
Newsgroups: comp.lang.python
Subject: Re: How to make sphinx to recognize functools.partial?
Date: Mon, 4 Apr 2016 01:42:08 +0100
Lines: 33
Message-ID: <mailman.422.1459730542.28225.python-list@python.org>
References: <5701B4B1.5000803@noaa.gov>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: 7bit
X-Trace: news.uni-berlin.de wH5FuHRIp0ItiRIPPyY+GgUW9v6eo6EdEhSnMu8pNE9w==
Return-Path: <python@mrabarnett.plus.com>
X-Original-To: python-list@python.org
Delivered-To: python-list@mail.python.org
X-Spam-Status: OK 0.001
X-Spam-Evidence: '*H*': 1.00; '*S*': 0.00; 'sphinx': 0.07; 'subject:How': 0.09; "'''": 0.09; '*args):': 0.09; 'subject:skip:f 10': 0.09; 'question.': 0.13; 'def': 0.13; 'created.': 0.16; 'from:addr:mrabarnett.plus.com': 0.16; 'from:addr:python': 0.16; 'from:name:mrab': 0.16; 'message-id:@mrabarnett.plus.com': 0.16; 'received:192.168.1.4': 0.16; 'received:84.93': 0.16; 'received:84.93.230': 0.16; 'received:io': 0.16; 'received:psf.io': 0.16; 'subject:make': 0.16; 'wrote:': 0.16; 'beginner': 0.18; 'recognize': 0.22; 'pass': 0.22; 'appears': 0.23; 'header:In-Reply-To:1': 0.24; 'module': 0.25; 'header:User- Agent:1': 0.26; 'code:': 0.29; 'print': 0.30; 'another': 0.32; "can't": 0.32; 'skip:_ 10': 0.32; 'received:84': 0.32; 'statement': 0.32; 'html,': 0.33; 'correctly': 0.34; 'definition': 0.34; 'running': 0.34; 'feed': 0.35; 'skip:: 10': 0.35; 'according': 0.36; 'but': 0.36; 'should': 0.36; 'to:addr:python- list': 0.36; 'subject:?': 0.36; 'subject:: ': 0.37; 'anything': 0.38; 'data': 0.39; 'received:192': 0.39; 'to:addr:python.org': 0.40; 'here.': 0.62; 'trojan': 0.91
X-CM-Score: 0.00
X-CNFS-Analysis: v=2.1 cv=bsGxfxui c=1 sm=1 tr=0 a=0nF1XD0wxitMEM03M9B4ZQ==:117 a=0nF1XD0wxitMEM03M9B4ZQ==:17 a=L9H7d07YOLsA:10 a=9cW_t1CCXrUA:10 a=s5jvgZ67dGcA:10 a=IkcTkHD0fZMA:10 a=0hoOTt9Y8BXtQ-ViT90A:9 a=QEXdDO2ut3YA:10
X-AUTH: mrabarnett@:2500
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:38.0) Gecko/20100101 Thunderbird/38.7.1
In-Reply-To: <5701B4B1.5000803@noaa.gov>
X-BeenThere: python-list@python.org
X-Mailman-Version: 2.1.21
Precedence: list
List-Id: General discussion list for the Python programming language <python-list.python.org>
List-Unsubscribe: <https://mail.python.org/mailman/options/python-list>, <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive: <http://mail.python.org/pipermail/python-list/>
List-Post: <mailto:python-list@python.org>
List-Help: <mailto:python-list-request@python.org?subject=help>
List-Subscribe: <https://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
Xref: csiph.com comp.lang.python:106421

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