IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merged revisions 64642-64643,64698 via svnmerge from

Browse Source 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64642 | georg.brandl | 2008-07-01 23:02:35 +0200 (Tue, 01 Jul 2008) | 2 lines

  #3251: label names are case insensitive.
........
  r64643 | georg.brandl | 2008-07-01 23:24:55 +0200 (Tue, 01 Jul 2008) | 2 lines

  Add a note about decorated functions.
........
  r64698 | georg.brandl | 2008-07-04 12:21:09 +0200 (Fri, 04 Jul 2008) | 2 lines

  Allow setting current module to None.
........
This commit is contained in:
Georg Brandl
2008-07-04 14:27:25 +00:00
parent 84d81f7936
commit 2e698fcb09
3 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/ext/autodoc.rst
View File

@@ -136,6 +136,17 @@ directive.
These work exactly like :dir:`autoclass` etc., but do not offer the options
used for automatic member documentation.
.. note::
If you document decorated functions or methods, keep in mind that autodoc
retrieves its docstrings by importing the module and inspecting the
``__doc__`` attribute of the given function or method. That means that if
a decorator replaces the decorated function with another, it must copy the
original ``__doc__`` to the new function.
From Python 2.5, :func:`functools.wraps` can be used to create
well-behaved decorating functions.
There are also new config values that you can set: