How to make sphinx to recognize functools.partial?

Path	csiph.com!fu-berlin.de!uni-berlin.de!not-for-mail
From	George Trojan <george.trojan@noaa.gov>
Newsgroups	comp.lang.python
Subject	How to make sphinx to recognize functools.partial?
Date	Mon, 4 Apr 2016 00:26:25 +0000
Lines	31
Message-ID	<mailman.421.1459729597.28225.python-list@python.org> (permalink)
Mime-Version	1.0
Content-Type	text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding	7bit
X-Trace	news.uni-berlin.de tq2s4MbvEuD77bVpRstiHwtpODCQ0gZD4tD3/PkYJl0A==
Return-Path	<george.trojan@noaa.gov>
X-Original-To	python-list@python.org
Delivered-To	python-list@mail.python.org
X-Spam-Status	OK 0.005
X-Spam-Evidence	'H': 0.99; '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; 'received:io': 0.16; 'received:psf.io': 0.16; 'subject:make': 0.16; 'beginner': 0.18; 'recognize': 0.22; 'pass': 0.22; 'appears': 0.23; '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; 'statement': 0.32; 'html,': 0.33; 'correctly': 0.34; 'definition': 0.34; 'running': 0.34; 'received:google.com': 0.35; 'feed': 0.35; 'skip:: 10': 0.35; 'according': 0.36; 'but': 0.36; 'received:209.85': 0.36; 'to:addr:python-list': 0.36; 'subject:?': 0.36; 'received:66': 0.38; 'received:209': 0.38; 'received:localdomain': 0.38; 'received:209.85.220': 0.38; 'data': 0.39; 'to:addr:python.org': 0.40; 'here.': 0.62
DKIM-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=noaa-gov.20150623.gappssmtp.com; s=20150623; h=to:from:subject:message-id:date:user-agent:mime-version :content-transfer-encoding; bh=JRLV/Z9FCAMCxPxiM8DVFGtG7LDjdRH2LDlxgzIdp18=; b=czT6O4q2meoe8eaLxSo3EaOON0NHD1jjc0DLSyky0IDu2LwifFwwljbqBz204MDVBU NxmZOvRnCbEjtbxKSno57TuvcRF/0lfXpuvLgeBz6y7yzZhW4QJSnOT5ulOL2jTjzqlh 54KUUfFKGPQ33xvVHMMnF/bgjVB7oGe+/11V6CQOSDJbINl7XqxRiA36duXQ9bmErQLg Cv/cy72Ze2dfBpQVhd+GjJAl0RGMwjcXMebAonC6qgYm/3ZPunsk8mXSMcLWJgMRGgMj JYwdZWb/XXSk8JXPwP2lKgFL4XpKnROSpSMGfeuOEas1TIUsnsXf0bqa/wGDiXvc8ddW AFoQ==
X-Google-DKIM-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:to:from:subject:message-id:date:user-agent :mime-version:content-transfer-encoding; bh=JRLV/Z9FCAMCxPxiM8DVFGtG7LDjdRH2LDlxgzIdp18=; b=fgKxKK+lPwBdgtn2WAowBzcAX30/FvenMpVrBIpLzzkXKsmiu8XR08QWZ1BjSWENlV uW27MfUlYszyqwsOPywwHXFMP3qJ8Spy3lESN2JzLZwuazmmYdUK0sAEl+2MsLe19Eqq Nb8eOguuemmJuLTuWxbEZMHuUhI/HPSh6hLNK0Cr4xd4g1FwD/cbzDfU/9ZPQMrcNPix Ke5VxdMnZQo2X/nttszYWOObkQzaNk48f/VZB+C8joFcQVS905MMjTjUu7rGwzwgDuia 18C9Zefzcll3I+H/kGXpsPFFXknFXy+sgtyWNB8Q3He+44F5VH/XLkFAeihJGsZA4iQa 0/uQ==
X-Gm-Message-State	AD7BkJJBaXPLxp9Vlh/Fnq0JWxmmKttbfnqm+Xg8Jb5qrsPaVLVhtuASzxcg7FB282BP/6f6
X-Received	by 10.66.123.105 with SMTP id lz9mr1329889pab.37.1459729587721; Sun, 03 Apr 2016 17:26:27 -0700 (PDT)
User-Agent	Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101 Thunderbird/38.5.0
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:106420

Show key headers only | View raw

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

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

Thread

How to make sphinx to recognize functools.partial? George Trojan <george.trojan@noaa.gov> - 2016-04-04 00:26 +0000

csiph-web