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

Add another indirection for formatting the name in Documenter.

Browse Source
This commit is contained in:
Georg Brandl 2009-05-24 21:36:27 +02:00
parent b28de861fe
commit 99c3ad9d6d
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
sphinx/ext/autodoc.py
View File

@ -361,6 +361,16 @@ class Documenter(object):
""" """
return None return None
def format_name(self):
"""
Format the name of *self.object*. This normally should be something
that can be parsed by the generated directive, but doesn't need to be
(Sphinx will display it unparsed then).
"""
# normally the name doesn't contain the module (except for module
# directives of course)
return '.'.join(self.objpath) or self.modname
def format_signature(self): def format_signature(self):
""" """
Format the signature (arguments and return annotation) of the object. Format the signature (arguments and return annotation) of the object.
@ -389,11 +399,8 @@ class Documenter(object):
def add_directive_header(self, sig): def add_directive_header(self, sig):
"""Add the directive header and options to the generated content.""" """Add the directive header and options to the generated content."""
directive = getattr(self, 'directivetype', self.objtype) directive = getattr(self, 'directivetype', self.objtype)
# the name to put into the generated directive -- doesn't contain name = self.format_name()
# the module (except for module directive of course) self.add_line(u'.. %s:: %s%s' % (directive, name, sig), '<autodoc>')
name_in_directive = '.'.join(self.objpath) or self.modname
self.add_line(u'.. %s:: %s%s' % (directive, name_in_directive, sig),
'<autodoc>')
if self.options.noindex: if self.options.noindex:
self.add_line(u' :noindex:', '<autodoc>') self.add_line(u' :noindex:', '<autodoc>')
if self.objpath: if self.objpath: