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

changelog update for PR#136

Browse Source
This commit is contained in:
Georg Brandl 2013-09-16 09:26:14 +02:00
parent d2b4f9a095
commit 44418fd1a1
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -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

11
doc/ext/autodoc.rst
View File

@ -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