Test automodsumm_special_methods_of option

ConorMacBride · ConorMacBride · commit a4191c5ee2d5 · 2021-11-15T19:46:04.000Z
Signed-off-by: Conor MacBride &lt;conor@macbride.me&gt;
diff --git a/sphinx_automodapi/tests/cases/special_methods/README.md b/sphinx_automodapi/tests/cases/special_methods/README.md
@@ -0,0 +1,2 @@
+Documenting a module with classes, also including special methods 
+for a particular list of classes.
diff --git a/sphinx_automodapi/tests/cases/special_methods/input/index.rst b/sphinx_automodapi/tests/cases/special_methods/input/index.rst
@@ -0,0 +1 @@
+.. automodapi:: sphinx_automodapi.tests.example_module.private_classes
diff --git a/sphinx_automodapi/tests/cases/special_methods/output/api/sphinx_automodapi.tests.example_module.private_classes.Banana.rst b/sphinx_automodapi/tests/cases/special_methods/output/api/sphinx_automodapi.tests.example_module.private_classes.Banana.rst
@@ -0,0 +1,17 @@
+Banana
+======
+
+.. currentmodule:: sphinx_automodapi.tests.example_module.private_classes
+
+.. autoclass:: Banana
+   :show-inheritance:
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~Banana.eat
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: eat
diff --git a/sphinx_automodapi/tests/cases/special_methods/output/api/sphinx_automodapi.tests.example_module.private_classes.Fruit.rst b/sphinx_automodapi/tests/cases/special_methods/output/api/sphinx_automodapi.tests.example_module.private_classes.Fruit.rst
@@ -0,0 +1,31 @@
+Fruit
+=====
+
+.. currentmodule:: sphinx_automodapi.tests.example_module.private_classes
+
+.. autoclass:: Fruit
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~Fruit.weight
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~Fruit.__len__
+      ~Fruit.buy
+      ~Fruit.eat
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: weight
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: __len__
+   .. automethod:: buy
+   .. automethod:: eat
diff --git a/sphinx_automodapi/tests/cases/special_methods/output/api/sphinx_automodapi.tests.example_module.private_classes.Orange.rst b/sphinx_automodapi/tests/cases/special_methods/output/api/sphinx_automodapi.tests.example_module.private_classes.Orange.rst
@@ -0,0 +1,19 @@
+Orange
+======
+
+.. currentmodule:: sphinx_automodapi.tests.example_module.private_classes
+
+.. autoclass:: Orange
+   :show-inheritance:
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~Orange.__add__
+      ~Orange.eat
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: __add__
+   .. automethod:: eat
diff --git a/sphinx_automodapi/tests/cases/special_methods/output/index.rst.automodapi b/sphinx_automodapi/tests/cases/special_methods/output/index.rst.automodapi
@@ -0,0 +1,19 @@
+
+sphinx_automodapi.tests.example_module.private_classes Module
+-------------------------------------------------------------
+
+.. automodule:: sphinx_automodapi.tests.example_module.private_classes
+
+Classes
+^^^^^^^
+
+.. automodsumm:: sphinx_automodapi.tests.example_module.private_classes
+    :classes-only:
+    :toctree: api
+
+Class Inheritance Diagram
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automod-diagram:: sphinx_automodapi.tests.example_module.private_classes
+    :private-bases:
+    :parts: 1
diff --git a/sphinx_automodapi/tests/cases/special_methods/output/index.rst.automodsumm b/sphinx_automodapi/tests/cases/special_methods/output/index.rst.automodsumm
@@ -0,0 +1,9 @@
+.. currentmodule:: sphinx_automodapi.tests.example_module.private_classes
+
+.. autosummary::
+    :toctree: api
+
+    Fruit
+    Banana
+    Orange
+
diff --git a/sphinx_automodapi/tests/test_cases.py b/sphinx_automodapi/tests/test_cases.py
@@ -83,6 +83,12 @@ def test_run_full_case(tmpdir, case_dir, parallel):
             'sphinx_automodapi.tests.example_module.private_classes.Fruit',
             'sphinx_automodapi.tests.example_module.private_classes.Banana',
         ]
+    if os.path.basename(case_dir) == 'special_methods':
+        conf['automodsumm_special_methods_of'] = [
+            'sphinx_automodapi.tests.example_module.private_classes.Fruit',
+            'sphinx_automodapi.tests.example_module.private_classes.Orange',
+        ]
+
     start_dir = os.path.abspath('.')
 
     src_dir = 'src' if 'source_dir' in case_dir else '.'

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Documenting a module with classes, also including special methods`
	`2`	`+for a particular list of classes.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+.. automodapi:: sphinx_automodapi.tests.example_module.private_classes`