summaryrefslogtreecommitdiffstats
path: root/tests/roots/test-ext-autosummary-skip-member
diff options
context:
space:
mode:
Diffstat (limited to 'tests/roots/test-ext-autosummary-skip-member')
-rw-r--r--tests/roots/test-ext-autosummary-skip-member/conf.py20
-rw-r--r--tests/roots/test-ext-autosummary-skip-member/index.rst4
-rw-r--r--tests/roots/test-ext-autosummary-skip-member/target.py14
3 files changed, 38 insertions, 0 deletions
diff --git a/tests/roots/test-ext-autosummary-skip-member/conf.py b/tests/roots/test-ext-autosummary-skip-member/conf.py
new file mode 100644
index 0000000..7c8f0e9
--- /dev/null
+++ b/tests/roots/test-ext-autosummary-skip-member/conf.py
@@ -0,0 +1,20 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('.'))
+
+
+extensions = ['sphinx.ext.autosummary']
+autosummary_generate = True
+autodoc_default_options = {'members': True}
+
+
+def skip_member(app, what, name, obj, skip, options):
+ if name == 'skipmeth':
+ return True
+ elif name == '_privatemeth':
+ return False
+
+
+def setup(app):
+ app.connect('autodoc-skip-member', skip_member)
diff --git a/tests/roots/test-ext-autosummary-skip-member/index.rst b/tests/roots/test-ext-autosummary-skip-member/index.rst
new file mode 100644
index 0000000..c376a13
--- /dev/null
+++ b/tests/roots/test-ext-autosummary-skip-member/index.rst
@@ -0,0 +1,4 @@
+.. autosummary::
+ :toctree: generate
+
+ target.Foo
diff --git a/tests/roots/test-ext-autosummary-skip-member/target.py b/tests/roots/test-ext-autosummary-skip-member/target.py
new file mode 100644
index 0000000..fdf557e
--- /dev/null
+++ b/tests/roots/test-ext-autosummary-skip-member/target.py
@@ -0,0 +1,14 @@
+class Foo:
+ """docstring of Foo."""
+
+ def meth(self):
+ """docstring of meth."""
+ pass
+
+ def skipmeth(self):
+ """docstring of skipmeth."""
+ pass
+
+ def _privatemeth(self):
+ """docstring of _privatemeth."""
+ pass