summaryrefslogtreecommitdiff
path: root/tests/test_autodoc.py
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2011-01-06 13:07:07 +0100
committerGeorg Brandl <georg@python.org>2011-01-06 13:07:07 +0100
commit0d1a8e572053993f535b147db1f5f1996cbb6d85 (patch)
tree5b6a4fbb10eb689c11914ffb03dd41dd7b5c63e3 /tests/test_autodoc.py
parent60037c3e4e5c672a0b6becc42525bed5ffac0f1c (diff)
parent86215260458069fdc9b64b58e111540e03f4ff6a (diff)
downloadsphinx-git-0d1a8e572053993f535b147db1f5f1996cbb6d85.tar.gz
merge with 1.0
Diffstat (limited to 'tests/test_autodoc.py')
-rw-r--r--tests/test_autodoc.py14
1 files changed, 14 insertions, 0 deletions
diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py
index 949ba9d45..8f9025e68 100644
--- a/tests/test_autodoc.py
+++ b/tests/test_autodoc.py
@@ -17,6 +17,7 @@ from docutils.statemachine import ViewList
from sphinx.ext.autodoc import AutoDirective, add_documenter, \
ModuleLevelDocumenter, FunctionDocumenter, cut_lines, between, ALL
+from StringIO import StringIO
def setup_module():
global app, lid, options, directive
@@ -418,6 +419,7 @@ def test_generate():
('attribute', 'test_autodoc.Class.attr'),
('attribute', 'test_autodoc.Class.docattr'),
('attribute', 'test_autodoc.Class.udocattr'),
+ ('attribute', 'test_autodoc.Class.mdocattr'),
('attribute', 'test_autodoc.Class.inst_attr_comment'),
('attribute', 'test_autodoc.Class.inst_attr_string')
])
@@ -486,11 +488,19 @@ def test_generate():
' .. py:attribute:: Class.prop',
' .. py:attribute:: Class.docattr',
' .. py:attribute:: Class.udocattr',
+ ' .. py:attribute:: Class.mdocattr',
' .. py:attribute:: Class.inst_attr_comment',
' .. py:attribute:: Class.inst_attr_string',
' .. py:method:: Class.inheritedmeth()',
],
'class', 'Class', member_order='bysource', all_members=True)
+ del directive.env.temp_data['py:module']
+
+ # test attribute initialized to class instance from other module
+ directive.env.temp_data['autodoc:class'] = 'test_autodoc.Class'
+ assert_result_contains(u' should be documented as well - s\xfc\xdf',
+ 'attribute', 'mdocattr')
+ del directive.env.temp_data['autodoc:class']
# test autodoc_docstring_signature
assert_result_contains(
@@ -561,6 +571,10 @@ class Class(Base):
udocattr = 'quux'
u"""should be documented as well - süß"""
+ # initialized to any class imported from another module
+ mdocattr = StringIO()
+ """should be documented as well - süß"""
+
def __init__(self, arg):
#: a documented instance attribute
self.inst_attr_comment = None