autosummary: Add :recursive: option to autosummary directive

4 files changed, 25 insertions, 1 deletions

diff --git a/tests/roots/test-ext-autosummary-recursive/index.rst b/tests/roots/test-ext-autosummary-recursive/index.rst
index d5292607c..5855bfa71 100644
--- a/tests/roots/test-ext-autosummary-recursive/index.rst
+++ b/tests/roots/test-ext-autosummary-recursive/index.rst
@@ -5,5 +5,11 @@ API Reference
 
 .. autosummary::
    :toctree: generated
+   :recursive:
 
     package
+
+.. autosummary::
+   :toctree: generated
+
+    package2
diff --git a/tests/roots/test-ext-autosummary-recursive/package2/__init__.py b/tests/roots/test-ext-autosummary-recursive/package2/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/tests/roots/test-ext-autosummary-recursive/package2/__init__.py
diff --git a/tests/roots/test-ext-autosummary-recursive/package2/module.py b/tests/roots/test-ext-autosummary-recursive/package2/module.py
new file mode 100644
index 000000000..5506d0bc9
--- /dev/null
+++ b/tests/roots/test-ext-autosummary-recursive/package2/module.py
@@ -0,0 +1,13 @@
+from os import *  # NOQA
+
+
+class Foo:
+    def __init__(self):
+        pass
+
+    def bar(self):
+        pass
+
+    @property
+    def baz(self):
+        pass
diff --git a/tests/test_ext_autosummary.py b/tests/test_ext_autosummary.py
index 7b59c8dd5..de439248e 100644
--- a/tests/test_ext_autosummary.py
+++ b/tests/test_ext_autosummary.py
@@ -292,6 +292,11 @@ def test_autosummary_recursive_enabled(app, status, warning):
     if toctree:
         assert not (generated / toctree).exists()
 
+    # autosummary without :recursive: option
+    generated = app.srcdir / 'generated'
+    assert (generated / 'package2.rst').exists()
+    assert not (generated / 'package2.module.rst').exists()
+
 
 @pytest.mark.sphinx('dummy', testroot='ext-autosummary-recursive',
                     srcdir='ext-autosummary-recursive-disabled',
@@ -382,7 +387,7 @@ def test_autosummary_imported_members(app, status, warning):
 @pytest.mark.sphinx(testroot='ext-autodoc')
 def test_generate_autosummary_docs_property(app):
     with patch('sphinx.ext.autosummary.generate.find_autosummary_in_files') as mock:
-        mock.return_value = [AutosummaryEntry('target.methods.Base.prop', 'prop', None)]
+        mock.return_value = [AutosummaryEntry('target.methods.Base.prop', 'prop', None, False)]
         generate_autosummary_docs([], output_dir=app.srcdir, builder=app.builder, app=app)
 
     content = (app.srcdir / 'target.methods.Base.prop.rst').text()