[Python-checkins] r62316 - doctools/trunk/doc/ext/autodoc.rst

[georg.brandl]

Author: georg.brandl
Date: Sun Apr 13 10:09:07 2008
New Revision: 62316

Log:
Add note about __module__ checking.


Modified:
   doctools/trunk/doc/ext/autodoc.rst

Modified: doctools/trunk/doc/ext/autodoc.rst
==============================================================================
--- doctools/trunk/doc/ext/autodoc.rst	(original)
+++ doctools/trunk/doc/ext/autodoc.rst	Sun Apr 13 10:09:07 2008
@@ -77,6 +77,13 @@
 
             Boil the noodle *time* minutes.
 
+   .. note::
+
+      In an :dir:`automodule` directive with the ``members`` option set, only
+      module members whose ``__module__`` attribute is equal to the module name
+      as given to ``automodule`` will be documented.  This is to prevent
+      documentation of imported classes or functions.
+
 
 .. directive:: autofunction
                automethod