diff options
| author | Georg Brandl <georg@python.org> | 2008-04-13 08:09:07 +0000 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2008-04-13 08:09:07 +0000 |
| commit | 2571218ab92f92bee5f2b728e9d4a08227d4468b (patch) | |
| tree | 1dd1ace0fcb81622e18745b7b554946a9dabdf7c /doc/ext | |
| parent | a011d3ae6c233940f1012cfacbf19920858570ba (diff) | |
| download | sphinx-git-2571218ab92f92bee5f2b728e9d4a08227d4468b.tar.gz | |
Add note about __module__ checking.
Diffstat (limited to 'doc/ext')
| -rw-r--r-- | doc/ext/autodoc.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst index 4af04555c..1c8d36dd0 100644 --- a/doc/ext/autodoc.rst +++ b/doc/ext/autodoc.rst @@ -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 |
