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

Use Unicode throughout autodoc.

Browse Source
This commit is contained in:
Georg Brandl 2008-06-17 08:07:37 +00:00
parent 2b20bdbfd7
commit c4ecb7faed
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
sphinx/ext/autodoc.py
View File

@ -154,8 +154,16 @@ def get_doc(what, obj, env):
charset = get_module_charset(module) charset = get_module_charset(module)
for docstring in docstrings: for docstring in docstrings:
if isinstance(docstring, str) and charset: if isinstance(docstring, str):
docstring = docstring.decode(charset) if charset:
docstring = docstring.decode(charset)
else:
try:
# try decoding with utf-8, should only work for real UTF-8
docstring = docstring.decode('utf-8')
except UnicodeError:
# last resort -- can't fail
docstring = docstring.decode('latin1')
for line in prepare_docstring(docstring): for line in prepare_docstring(docstring):
yield line yield line
@ -178,7 +186,7 @@ def format_signature(what, obj):
def generate_rst(what, name, members, inherited, undoc, add_content, document, def generate_rst(what, name, members, inherited, undoc, add_content, document,
lineno, indent='', filename_set=None, check_module=False): lineno, indent=u'', filename_set=None, check_module=False):
env = document.settings.env env = document.settings.env
result = None result = None
@ -291,20 +299,20 @@ def generate_rst(what, name, members, inherited, undoc, add_content, document,
# necessary for some situations where another directive preprocesses # necessary for some situations where another directive preprocesses
# reST and no starting newline is present # reST and no starting newline is present
result = ViewList() result = ViewList()
result.append('', '') result.append(u'', '')
# now, create the directive header # now, create the directive header
result.append(indent + '.. %s:: %s%s' % (what, name_in_directive, args), result.append(indent + u'.. %s:: %s%s' % (what, name_in_directive, args),
'<autodoc>') '<autodoc>')
if what != 'module': if what != 'module':
# Be explicit about the module, this is necessary since .. class:: doesn't # Be explicit about the module, this is necessary since .. class:: doesn't
# support a prepended module name # support a prepended module name
result.append(indent + ' :module: %s' % mod, '<autodoc>') result.append(indent + u' :module: %s' % mod, '<autodoc>')
result.append('', '<autodoc>') result.append(u'', '<autodoc>')
# the module directive doesn't have content # the module directive doesn't have content
if what != 'module': if what != 'module':
indent += ' ' indent += u' '
if modfile: if modfile:
sourcename = '%s:docstring of %s' % (modfile, fullname) sourcename = '%s:docstring of %s' % (modfile, fullname)