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 trunk

Browse Source
This commit is contained in:
Georg Brandl 2010-02-28 15:24:47 +01:00
commit f37588d87f
2 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES
View File

@ -121,6 +121,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.

18
sphinx/ext/autodoc.py
View File

@ -597,26 +597,26 @@ 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))
member_order = self.options.member_order or \ member_order = self.options.member_order or \
self.env.config.autodoc_member_order self.env.config.autodoc_member_order
if member_order == 'groupwise': if member_order == '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 e: e[0].member_order)
elif member_order == 'bysource' and self.analyzer: elif member_order == 'bysource' and self.analyzer:
# sort by source order, by virtue of the module analyzer # sort by source order, by virtue of the module analyzer
tagorder = self.analyzer.tagorder tagorder = self.analyzer.tagorder
def keyfunc(documenter): def keyfunc(entry):
fullname = documenter.name.split('::')[1] fullname = entry[0].name.split('::')[1]
return tagorder.get(fullname, len(tagorder)) return tagorder.get(fullname, len(tagorder))
memberdocumenters.sort(key=keyfunc) memberdocumenters.sort(key=keyfunc)
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.temp_data['autodoc:module'] = None self.env.temp_data['autodoc:module'] = None