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

merge with 0.6

Browse Source
This commit is contained in:
Georg Brandl 2010-02-28 15:21:54 +01:00
commit 3f1092fcc4
3 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES
View File

@ -89,6 +89,9 @@ Release 1.0 (in development)
Release 0.6.5 (in development) 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`` * #345: Fix cropping of sidebar scroll bar with ``stickysidebar``
option of the default theme. option of the default theme.

2
sphinx/environment.py
View File

@ -1592,6 +1592,8 @@ class BuildEnvironment:
else: else:
if name in self.descrefs: if name in self.descrefs:
newname = name newname = name
elif classname and classname + '.' + name in self.descrefs:
newname = classname + '.' + name
elif modname and modname + '.' + name in self.descrefs: elif modname and modname + '.' + name in self.descrefs:
newname = modname + '.' + name newname = modname + '.' + name
elif modname and classname and \ elif modname and classname and \

14
sphinx/ext/autodoc.py
View File

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