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

show docs for decorated special functions

Browse Source
This commit is contained in:
Yuxin Wu
2020-07-03 16:57:15 -07:00
parent 27ac10de04
commit 85fd0d870d
4 changed files with 31 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
tests/test_ext_napoleon.py
View File

@@ -14,6 +14,7 @@ from collections import namedtuple
from unittest import TestCase, mock
from sphinx.application import Sphinx
from sphinx.testing.util import simple_decorator
from sphinx.ext.napoleon import _process_docstring, _skip_member, Config, setup
@@ -50,6 +51,11 @@ class SampleClass:
def __special_undoc__(self):
pass
@simple_decorator
def __decorated_func__(self):
"""doc"""
pass
class SampleError(Exception):
def _private_doc(self):
@@ -130,8 +136,8 @@ class SkipMemberTest(TestCase):
self.assertEqual(None, _skip_member(app, what, member, obj, skip,
mock.Mock()))
else:
self.assertFalse(_skip_member(app, what, member, obj, skip,
mock.Mock()))
self.assertIs(_skip_member(app, what, member, obj, skip,
mock.Mock()), False)
setattr(app.config, config_name, False)
self.assertEqual(None, _skip_member(app, what, member, obj, skip,
mock.Mock()))
@@ -170,6 +176,11 @@ class SkipMemberTest(TestCase):
SampleClass.__special_undoc__, True,
'napoleon_include_special_with_doc')
def test_class_decorated_doc(self):
self.assertSkip('class', '__decorated_func__',
SampleClass.__decorated_func__, False,
'napoleon_include_special_with_doc')
def test_exception_private_doc(self):
self.assertSkip('exception', '_private_doc',
SampleError._private_doc, False,