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

Add note about __module__ checking.

Browse Source
This commit is contained in:
Georg Brandl 2008-04-13 08:09:07 +00:00
parent a011d3ae6c
commit 2571218ab9
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/ext/autodoc.rst
View File

@ -77,6 +77,13 @@ directive.
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