diff options
| author | georg.brandl <devnull@localhost> | 2008-05-06 18:23:36 +0000 |
|---|---|---|
| committer | georg.brandl <devnull@localhost> | 2008-05-06 18:23:36 +0000 |
| commit | 16af8edb0f034af9fe355fbb18aa020d54c8d498 (patch) | |
| tree | 68b0ef8b6e328838c042b2b28a3dea23f3af9339 /doc/ext/autodoc.rst | |
| parent | f39aa50dba7f5c3bf0a6acbc0c4fec25010d0e5c (diff) | |
| download | sphinx-16af8edb0f034af9fe355fbb18aa020d54c8d498.tar.gz | |
Minor enhancements to generate_rst.
Diffstat (limited to 'doc/ext/autodoc.rst')
| -rw-r--r-- | doc/ext/autodoc.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst index 1a70c194..e7e29560 100644 --- a/doc/ext/autodoc.rst +++ b/doc/ext/autodoc.rst @@ -70,13 +70,15 @@ directive. .. 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:: + gained from instropection: + + :: - .. autoclass:: Noodle(type) + .. autoclass:: Noodle(type) - .. automethod:: eat(persona) + .. automethod:: eat(persona) - This is useful if the signature from the method is hidden by a decorator. + 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 |