[docs] [issue15527] Double parens in functions references

Fri Aug 10 21:40:02 CEST 2012

Chris Jerdonek added the comment:
- a distinct non-*NULL* pointer if possible, as if :c:func:`PyMem_Malloc(1)` had
+ a distinct non-*NULL* pointer if possible, as if ``PyMem_Malloc(1)`` had
> From my perspective sphinx doesn't allow notations like :c:func:`PyMem_Malloc(1)`

I believe that it does. Sphinx allows you to specify link text distinct from the target for various roles:
http://docs.python.org/devguide/documenting.html#id3
So for the above, it would be--
:c:func:`PyMem_Malloc(1) <PyMem_Malloc>`

I confirmed that this works. I think this is preferable to displaying the preferred text without any hyperlink.
----------
nosy: +cjerdonek
_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue15527>
_______________________________________