classification
Title: Autodoc should skip inherited methods
Type: behavior Stage:
Components: Documentation tools (Sphinx) Versions: Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: georg.brandl, jmillikin
Priority: normal Keywords:

Created on 2008-04-18 21:02 by jmillikin, last changed 2008-05-04 09:09 by georg.brandl. This issue is now closed.

Messages (2)
msg65624 - (view) Author: John Millikin (jmillikin) Date: 2008-04-18 21:02
Using the following class layout:

class A (object):
	def a (self):
		"A.a"
		pass
class B (A):
	def b (self):
		"B.b"
		pass

If sphinx.ext.autodoc is used to extract documentation, the entry for
class B will have subentries for both the a() and b() methods. This is
unnecessary clutter. It would be nice if the inherited method was
skipped when documenting B, or even better if it was inserted as a
"stub" linking to the documentation for A.a().
msg66198 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2008-05-04 09:09
Thanks. In SVN (r62695), autodoc now skips inherited members unless the
:inherited-members: flag option is given.
History
Date User Action Args
2008-05-04 09:09:34georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg66198
2008-04-18 21:02:43jmillikincreate