This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author pv
Recipients georg.brandl, pv
Date 2008-07-20.23:08:31
SpamBayes Score 0.002358143
Marked as misclassified No
Message-id <1216595315.74.0.23412143047.issue3422@psf.upfronthosting.co.za>
In-reply-to
Content
It would be useful if the 

    autodoc-process-docstring

event from sphinx.ext.autodoc allowed to change the argspec of the 
function being documented. Some other hook for changing the function 
signature would also do.

We are using Sphinx for generating a reference guide for Numpy, where 
many of the functions are from extension modules for which 
inspect.getargspec does not work. Instead, the function signature is 
contained within the object's docstring. Right now I'm simply 
monkeypatching sphinx.ext.autodoc.format_signature, but a cleaner 
approach would be better.

It seems that this would be fairly easy to implement in generate_rst. 
Perhaps a .signature attribute to the Options passed to the hook would 
be an acceptable solution?

I can write a patch doing this, if someone doesn't do this faster.
History
Date User Action Args
2008-07-20 23:08:36pvsetspambayes_score: 0.00235814 -> 0.002358143
recipients: + pv, georg.brandl
2008-07-20 23:08:35pvsetspambayes_score: 0.00235814 -> 0.00235814
messageid: <1216595315.74.0.23412143047.issue3422@psf.upfronthosting.co.za>
2008-07-20 23:08:34pvlinkissue3422 messages
2008-07-20 23:08:32pvcreate