""" Module for testing the autodocsumm ---------------------------------- Just a dummy module with some class definitions """ #: to test if the data is included test_data = None def test_func(): """Test if function is contained in autosummary""" pass class Class_CallTest(object): """A class defining a __call__ method""" def __get__(self, instance, owner): return self def __set__(self, instance, value): """Actually not required. We just implement it to ensure the python "help" function works well""" pass def __call__(self, a, b): """ Caller docstring for class attribute Parameters ---------- a: any dummy parameter b: anything else second dummy parameter""" pass class TestClass(object): """Class test for autosummary""" def test_method(self): """Test if the method is included""" pass #: to test if the class attribute is included test_attr = None class_caller = Class_CallTest() #: data to be included large_data = 'Should be included' #: data to be skipped small_data = 'Should be skipped' #: data to be skipped large_data = 'Should also be skipped' #: data to be included small_data = 'Should also be included'