In autodoc, fix the omission of some module members explicitly documented using documentation comments.

This commit is contained in:
Georg Brandl
2010-02-28 15:20:11 +01:00
parent 0341cc7c3d
commit 030f4c451b
2 changed files with 10 additions and 7 deletions

View File

@@ -1,6 +1,9 @@
Release 0.6.5 (in development)
==============================
* In autodoc, fix the omission of some module members explicitly
documented using documentation comments.
* #345: Fix cropping of sidebar scroll bar with ``stickysidebar``
option of the default theme.

View File

@@ -574,19 +574,19 @@ class Documenter(object):
# of inner classes can be documented
full_mname = self.modname + '::' + \
'.'.join(self.objpath + [mname])
memberdocumenters.append(
classes[-1](self.directive, full_mname, self.indent))
documenter = classes[-1](self.directive, full_mname, self.indent)
memberdocumenters.append((documenter, isattr))
if (self.options.member_order or self.env.config.autodoc_member_order) \
== 'groupwise':
# sort by group; relies on stable sort to keep items in the
# same group sorted alphabetically
memberdocumenters.sort(key=lambda d: d.member_order)
memberdocumenters.sort(key=lambda d: d[0].member_order)
for documenter in memberdocumenters:
documenter.generate(all_members=True,
real_modname=self.real_modname,
check_module=members_check_module)
for documenter, isattr in memberdocumenters:
documenter.generate(
all_members=True, real_modname=self.real_modname,
check_module=members_check_module and not isattr)
# reset current objects
self.env.autodoc_current_module = None