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 in Vladimirsson/sphinx (pull request #136)

Browse Source 
Added ``imported-members`` option for ``automodule`` directive in autodoc
This commit is contained in:
Georg Brandl
2013-09-16 09:23:56 +02:00
parent 2b67a52bb8 a7a4f7569a
commit d2b4f9a095
2 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
doc/ext/autodoc.rst
View File

@@ -184,12 +184,17 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
.. versionadded:: 0.6
.. note::
* In an :rst: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.
Set ``imported-members`` option if you want to preven this behavior and
document all available members.
Note that attributes from imported modules will not be documented,
because attribute documentation is discovered by parsing the source file
of the current module.
In an :rst: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.
.. versionadded:: 1.2
.. rst:directive:: autofunction