diff options
author | Georg Brandl <georg@python.org> | 2013-09-16 09:26:14 +0200 |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2013-09-16 09:26:14 +0200 |
commit | b3bc38eb4d2e13e2ccf3a7985b2a02d7528eb5dd (patch) | |
tree | c8ee8c9c0fede78831bd5340000d9319a66a3919 | |
parent | 7167989b449e1b6d141671c1477170d11df7865f (diff) | |
download | sphinx-b3bc38eb4d2e13e2ccf3a7985b2a02d7528eb5dd.tar.gz |
changelog update for PR#136
-rw-r--r-- | CHANGES | 2 | ||||
-rw-r--r-- | doc/ext/autodoc.rst | 11 |
2 files changed, 7 insertions, 6 deletions
@@ -13,6 +13,8 @@ Features added * Autodoc directives for module data and attributes now support an ``annotation`` option, so that the default display of the data/attribute value can be overridden. +* PR#136: Autodoc directives now support an ``imported-members`` option to + include members imported from different modules. * New locales: Macedonian, Sinhala, Indonesian. Incompatible changes diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst index c351f50e..c92fe0c4 100644 --- a/doc/ext/autodoc.rst +++ b/doc/ext/autodoc.rst @@ -187,12 +187,11 @@ inserting them into the page source under a suitable :rst:dir:`py: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. - 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. + documentation of imported classes or functions. Set the + ``imported-members`` option if you want to prevent 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. .. versionadded:: 1.2 |