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 tests for mocked modules

Browse Source
This commit is contained in:
Michael Leinartas 2016-10-21 09:53:25 -05:00
parent f8200bdddc
commit 7943da9408
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
tests/root/autodoc_missing_imports.py
View File

@ -5,5 +5,14 @@ import missing_package1.missing_module1
from missing_package2 import missing_module2 from missing_package2 import missing_module2
from missing_package3.missing_module3 import missing_name from missing_package3.missing_module3 import missing_name
@missing_name
def decoratedFunction():
"""decoratedFunction docstring"""
return None
class TestAutodoc(object): class TestAutodoc(object):
"""TestAutodoc docstring.""" """TestAutodoc docstring."""
@missing_name
def decoratedMethod(self):
"""TestAutodoc::decoratedMethod docstring"""
return None

11
tests/test_autodoc.py
View File

@ -832,6 +832,17 @@ def test_generate():
assert_result_contains(' .. py:method:: CustomDataDescriptor.meth()', assert_result_contains(' .. py:method:: CustomDataDescriptor.meth()',
'module', 'test_autodoc') 'module', 'test_autodoc')
# test mocked module imports
options.members = ['TestAutodoc']
options.undoc_members = False
assert_result_contains('.. py:class:: TestAutodoc',
'module', 'autodoc_missing_imports')
assert_result_contains(' .. py:method:: TestAutodoc.decoratedMethod()',
'module', 'autodoc_missing_imports')
options.members = ['decoratedFunction']
assert_result_contains('.. py:function:: decoratedFunction()',
'module', 'autodoc_missing_imports')
# --- generate fodder ------------ # --- generate fodder ------------
__all__ = ['Class'] __all__ = ['Class']