diff options
| author | armin.ronacher <devnull@localhost> | 2008-05-06 18:07:17 +0000 |
|---|---|---|
| committer | armin.ronacher <devnull@localhost> | 2008-05-06 18:07:17 +0000 |
| commit | f39aa50dba7f5c3bf0a6acbc0c4fec25010d0e5c (patch) | |
| tree | 9561f11156095311289fa8b8f6a84626ce857a32 /doc/ext | |
| parent | ae0ce1ceff59f0e6c8428da958a3c7a26f1bcb9c (diff) | |
| download | sphinx-f39aa50dba7f5c3bf0a6acbc0c4fec25010d0e5c.tar.gz | |
added support for explicit signatures in callables
Diffstat (limited to 'doc/ext')
| -rw-r--r-- | doc/ext/autodoc.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst index 3f2b395e..1a70c194 100644 --- a/doc/ext/autodoc.rst +++ b/doc/ext/autodoc.rst @@ -67,6 +67,17 @@ directive. For classes and exceptions, members inherited from base classes will be left out, unless you give the ``inherited-members`` flag option. + .. versionadded:: 0.4 + It's possible to override the signature for callable members (functions, + methods, classes) with the regular syntax that will override the signature + gained from instropection:: + + .. autoclass:: Noodle(type) + + .. automethod:: eat(persona) + + This is useful if the signature from the method is hidden by a decorator. + The "auto" directives can also contain content of their own, it will be inserted into the resulting non-auto directive source after the docstring (but before any automatic member documentation). |
