Test automodsumm_private_methods_of option

Signed-off-by: Conor MacBride <[email protected]>

Author: ConorMacBride

sphinx_automodapi/tests/cases/private_methods/README.md

@@ -0,0 +1,2 @@
+Documenting a module with classes, also including private methods 
+for a particular list of classes.

sphinx_automodapi/tests/cases/private_methods/input/index.rst

@@ -0,0 +1 @@
+.. automodapi:: sphinx_automodapi.tests.example_module.private_classes

sphinx_automodapi/tests/cases/private_methods/output/api/sphinx_automodapi.tests.example_module.private_classes.Banana.rst

@@ -0,0 +1,19 @@
+Banana
+======
+
+.. currentmodule:: sphinx_automodapi.tests.example_module.private_classes
+
+.. autoclass:: Banana
+   :show-inheritance:
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~Banana._energy
+      ~Banana.eat
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: _energy
+   .. automethod:: eat

sphinx_automodapi/tests/cases/private_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._out_of_date
+      ~Fruit.buy
+      ~Fruit.eat
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: weight
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: _out_of_date
+   .. automethod:: buy
+   .. automethod:: eat

sphinx_automodapi/tests/cases/private_methods/output/api/sphinx_automodapi.tests.example_module.private_classes.Orange.rst

@@ -0,0 +1,17 @@
+Orange
+======
+
+.. currentmodule:: sphinx_automodapi.tests.example_module.private_classes
+
+.. autoclass:: Orange
+   :show-inheritance:
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~Orange.eat
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: eat

sphinx_automodapi/tests/cases/private_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

sphinx_automodapi/tests/cases/private_methods/output/index.rst.automodsumm

@@ -0,0 +1,9 @@
+.. currentmodule:: sphinx_automodapi.tests.example_module.private_classes
+
+.. autosummary::
+    :toctree: api
+
+    Fruit
+    Banana
+    Orange
+

sphinx_automodapi/tests/example_module/private_classes.py

@@ -0,0 +1,90 @@
+__all__ = ['Fruit', 'Banana', 'Orange']
+
+
+class Fruit(object):
+    """
+    An fruit
+    """
+    def eat(self, time):
+        """
+        Eat apple.
+        """
+        pass
+
+    def buy(self, price):
+        """
+        Buy apple.
+        """
+        pass
+
+    @property
+    def weight(self):
+        """
+        The weight of the apple.
+        """
+        return 0
+
+    @property
+    def _age(self):
+        """
+        The age of the fruit.
+        """
+        return 0
+
+    def __len__(self):
+        """
+        The length the fruit.
+        """
+        return 0
+
+    def _out_of_date(self, date):
+        """
+        Is it out of date?
+        """
+        pass
+
+
+class Banana(Fruit):
+    """
+    A banana
+    """
+    def eat(self, time):
+        """
+        Eat banana.
+        """
+        pass
+
+    def _energy(self, units='kcal'):
+        """
+        The energy in the banana.
+        """
+        pass
+
+    def __add__(self, other):
+        """
+        How to add the banana to something.
+        """
+        pass
+
+
+class Orange(Fruit):
+    """
+    An orange
+    """
+    def eat(self, time):
+        """
+        Eat orange.
+        """
+        pass
+
+    def _energy(self, units='kcal'):
+        """
+        The energy in the orange.
+        """
+        pass
+
+    def __add__(self, other):
+        """
+        How to add the orange to something.
+        """
+        pass

sphinx_automodapi/tests/test_cases.py

@@ -78,6 +78,11 @@ def test_run_full_case(tmpdir, case_dir, parallel):
                                       'allowed_names'):
         conf['extensions'].append('sphinx_automodapi.smart_resolver')
 
+    if os.path.basename(case_dir) == 'private_methods':
+        conf['automodsumm_private_methods_of'] = [
+            'sphinx_automodapi.tests.example_module.private_classes.Fruit',
+            'sphinx_automodapi.tests.example_module.private_classes.Banana',
+        ]
     start_dir = os.path.abspath('.')
 
     src_dir = 'src' if 'source_dir' in case_dir else '.'